> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gohusky.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Cadastro de webhook

> Cria um webhook para receber notificações em tempo real sobre eventos do sistema.



## OpenAPI

````yaml POST /notifications
openapi: 3.1.0
info:
  title: API Pública
  description: >-
    API da Husky, teste uma plataforma de logística para delivery e entregas.
    Aqui você encontra todas as informações necessárias para integrar o sistema
    Husky em seu aplicativo ou sistema.
  version: 0.0.1
servers:
  - url: https://sandbox.api.gohusky.net
    description: Ambiente de Homologação, use para testes e desenvolvimento.
  - url: https://api.gohusky.net
    description: Ambiente de Produção, use para produção.
security: []
paths:
  /notifications:
    post:
      tags:
        - Notificações
      summary: Criar Webhook
      description: >-
        Cria um webhook para receber notificações em tempo real sobre eventos do
        sistema.
      operationId: createNotification
      parameters:
        - $ref: '#/components/parameters/live_mode'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - event
                - url
              properties:
                event:
                  $ref: '#/components/schemas/EventEnum'
                  description: Tipo de evento para notificar por webhook
                url:
                  description: URL para receber as notificações por webhook
                  type: string
                  example: https://www.seusite.com.br/url
      responses:
        '200':
          description: Notificação cadastrada com sucesso
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: ID da notificação
                      example: NTF-5e42e35a958f0
                    event:
                      $ref: '#/components/schemas/EventEnum'
                      description: Tipo de evento cadastrado
                    url:
                      type: string
                      description: URL para receber as notificações
                      example: https://www.seusite.com.br/url
        '400':
          description: Erro ao cadastrar notificação
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
      security:
        - TokenQuery: []
components:
  parameters:
    live_mode:
      name: live_mode
      in: query
      description: Especifica o ambiente para executar a requisição.
      required: true
      schema:
        type: boolean
  schemas:
    EventEnum:
      type: string
      enum:
        - ORDER_STATUS_UPDATED
        - FLEET_QUEUE
        - ORDER_CREATED
        - ORDER_UPDATED
        - ORDER_DRIVER_UPDATED
        - DRIVER_CREATED
        - DRIVER_UPDATED
        - DRIVER_STATUS_UPDATED
        - CLIENT_CREATED
        - CLIENT_UPDATED
        - CLIENT_STATUS_UPDATED
        - all
      example: ORDER_STATUS_UPDATED
      description: >-
        Tipo de evento para notificação. Para mais detalhes sobre os possíveis
        eventos, consulte a seção [Webhooks](/api-reference/webhooks/webhook).


        Se informado ```all```, todos os eventos que existem hoje (e futuros)
        serão notificados.
  responses:
    '401':
      description: Token inválido ou não autorizado
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: integer
                example: 0
              message:
                type: string
                example: Token inválido ou não autorizado
    '404':
      description: Token não informado corretamente
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: integer
                example: 0
              message:
                type: string
                example: Token não informado corretamente
    '405':
      description: Método não permitido
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: integer
                example: 0
              message:
                type: string
                example: Método não permitido, consulte a documentação.
  securitySchemes:
    TokenQuery:
      type: apiKey
      description: >-
        Token de autenticação via query parameter. Pode representar o ID público
        da operação (Operador Logístico) ou o ID público do embarcador
        (Restaurante, loja, farmácia).
      name: token
      in: query

````