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

# Criar webhook

> Registre um endpoint de webhook em um canal

## Conceituação

Registra um novo endpoint de webhook no canal. A partir da criação, o {projectName} passa a enviar os eventos configurados para a URL informada.

Um canal pode ter múltiplos webhooks — útil para enviar eventos diferentes para sistemas diferentes, ou para manter webhooks com formatos distintos.

### Assinatura HMAC

Se `signing: true`, o campo `secret` é gerado automaticamente e retornado **apenas nesta resposta**. Armazene-o com segurança — ele não será exibido novamente em nenhuma outra chamada.

Use o `secret` para verificar a autenticidade das requisições recebidas no seu servidor. Calcule o HMAC-SHA256 sobre o body recebido usando o `secret` e compare com o header de assinatura enviado pelo {projectName}.

<Warning>
  Este endpoint requer a role **ENTERPRISE** na sua conta.
</Warning>

<Note>
  O `channelId` é obtido através do endpoint [Criar canal](/channels/create-channel).
</Note>


## OpenAPI

````yaml pt/webhooks/openapi.json POST /v1/channels/{channelId}/webhooks
openapi: 3.1.0
info:
  title: Hub Message - Webhooks API
  description: >-
    API para criar e gerenciar endpoints de webhook por canal. Requer role
    ENTERPRISE.
  version: 1.0.0
servers:
  - url: https://api.hubmessage.io
security:
  - bearerAuth: []
paths:
  /v1/channels/{channelId}/webhooks:
    post:
      tags:
        - Webhooks
      summary: Criar webhook
      description: >-
        Registra um novo endpoint de webhook no canal. A partir da criação, os
        eventos configurados passam a ser entregues na URL informada.
      operationId: createWebhook
      parameters:
        - name: channelId
          in: path
          required: true
          description: ID do canal
          schema:
            type: string
            example: 019E4C54B1B375A28970B605CA9B03C3
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWebhookRequest'
            examples:
              basic:
                summary: Básico — receber mensagens
                value:
                  url: https://app.suaempresa.com/webhooks/hubmessage
                  events:
                    - MESSAGE_RECEIVED
              withSignature:
                summary: Com assinatura HMAC
                value:
                  url: https://app.suaempresa.com/webhooks/hubmessage
                  events:
                    - MESSAGE_RECEIVED
                    - MESSAGE_STATUS
                  signing: true
              withBearerAuth:
                summary: Com autenticação Bearer
                value:
                  url: https://app.suaempresa.com/webhooks/hubmessage
                  events:
                    - MESSAGE_RECEIVED
                    - CONNECTED
                    - DISCONNECTED
                  auth:
                    type: BEARER
                    token: meu-token-secreto
              withBasicAuth:
                summary: Com autenticação Basic
                value:
                  url: https://app.suaempresa.com/webhooks/hubmessage
                  events:
                    - MESSAGE_RECEIVED
                  auth:
                    type: BASIC
                    username: webhook-user
                    password: senha-secreta
              withCustomHeader:
                summary: Com header customizado
                value:
                  url: https://app.suaempresa.com/webhooks/hubmessage
                  events:
                    - MESSAGE_RECEIVED
                    - MESSAGE_STATUS
                  auth:
                    type: CUSTOM_HEADER
                    headerName: X-Api-Key
                    headerValue: minha-chave-api
              allEvents:
                summary: Todos os eventos com HMAC + Bearer
                value:
                  url: https://app.suaempresa.com/webhooks/hubmessage
                  description: Webhook principal de produção
                  events:
                    - MESSAGE_RECEIVED
                    - MESSAGE_DELIVERY
                    - MESSAGE_STATUS
                    - CONNECTED
                    - DISCONNECTED
                  signing: true
                  auth:
                    type: BEARER
                    token: meu-token-secreto
      responses:
        '201':
          description: >-
            Webhook criado com sucesso. O campo `secret` é retornado **apenas
            nesta resposta** quando `signing` é `true` — armazene-o com
            segurança.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookCreatedResponse'
              examples:
                withSigning:
                  summary: Com assinatura HMAC habilitada
                  value:
                    id: A1B2C3D4E5F6789012345678901234AB
                    channelId: 019E4C54B1B375A28970B605CA9B03C3
                    instanceId: 019E4C54B1B375A28970B605CA9B03C3
                    url: https://app.suaempresa.com/webhooks/hubmessage
                    description: null
                    events:
                      - MESSAGE_RECEIVED
                      - MESSAGE_STATUS
                    status: ENABLED
                    signing: true
                    secret: >-
                      a3f1c2d4e5b6789012345678901234abcdef0123456789abcdef0123456789ab
                    auth:
                      type: NONE
                      configured: false
                    payloadFormat: DEFAULT
                    customAttributes: {}
                    createdAt: 2025-01-15T10:30:00.000+0000
                    updatedAt: 2025-01-15T10:30:00.000+0000
                withoutSigning:
                  summary: Sem assinatura HMAC
                  value:
                    id: B2C3D4E5F6789012345678901234AB12
                    channelId: 019E4C54B1B375A28970B605CA9B03C3
                    instanceId: 019E4C54B1B375A28970B605CA9B03C3
                    url: https://app.suaempresa.com/webhooks/hubmessage
                    description: Webhook principal de produção
                    events:
                      - MESSAGE_RECEIVED
                      - CONNECTED
                      - DISCONNECTED
                    status: ENABLED
                    signing: false
                    auth:
                      type: BEARER
                      configured: true
                    payloadFormat: DEFAULT
                    customAttributes: {}
                    createdAt: 2025-01-15T10:30:00.000+0000
                    updatedAt: 2025-01-15T10:30:00.000+0000
        '400':
          description: Requisição inválida — url ou events ausentes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: 400
                message: url is required
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          description: Regra de negócio violada — conta sem role ENTERPRISE
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: 422
                message: This action requires ENTERPRISE role
components:
  schemas:
    CreateWebhookRequest:
      type: object
      required:
        - url
        - events
      properties:
        url:
          type: string
          description: URL de destino dos eventos (máx. 2048 caracteres)
          example: https://app.suaempresa.com/webhooks/hubmessage
        description:
          type: string
          description: Descrição opcional do webhook
          example: Webhook principal de produção
        events:
          type: array
          description: Tipos de evento a receber. Pelo menos um obrigatório.
          items:
            type: string
            enum:
              - MESSAGE_RECEIVED
              - MESSAGE_DELIVERY
              - MESSAGE_STATUS
              - RECEIVED_STATUS
              - RECEIVED_AND_DELIVERY
              - CONNECTED
              - DISCONNECTED
              - PRESENCE_CHAT
              - INITIAL_DATA
              - BLOCK
          example:
            - MESSAGE_RECEIVED
            - MESSAGE_STATUS
        signing:
          type: boolean
          description: >-
            Habilita assinatura HMAC-SHA256. Quando `true`, um `secret` de 64
            caracteres hex é gerado e retornado **apenas na
            criação/atualização**. Use-o para verificar a autenticidade das
            requisições recebidas.
          default: false
          example: true
        auth:
          $ref: '#/components/schemas/WebhookAuth'
        payloadFormat:
          type: string
          enum:
            - DEFAULT
          description: Formato do payload entregue ao webhook.
          default: DEFAULT
          example: DEFAULT
        customAttributes:
          type: object
          description: Atributos extras
          additionalProperties: true
          example: {}
    WebhookCreatedResponse:
      allOf:
        - $ref: '#/components/schemas/WebhookResponse'
        - type: object
          properties:
            secret:
              type: string
              description: >-
                Segredo HMAC de 64 caracteres hex — retornado **apenas** quando
                `signing` é habilitado no create ou update. Armazene-o com
                segurança; não poderá ser recuperado depois.
              example: a3f1c2d4e5b6789012345678901234abcdef0123456789abcdef0123456789ab
    Error:
      type: object
      properties:
        error:
          type: integer
        message:
          type: string
    WebhookAuth:
      type: object
      description: Configura como o Hub Message se autentica ao chamar sua URL
      properties:
        type:
          type: string
          enum:
            - NONE
            - BEARER
            - API_KEY
            - BASIC
            - CUSTOM_HEADER
          description: Tipo de autenticação
          example: BEARER
        token:
          type: string
          description: >-
            Token para autenticação `BEARER` — enviado no header `Authorization:
            Bearer <token>`
          example: meu-token-secreto
        key:
          type: string
          description: Chave para autenticação `API_KEY`
        username:
          type: string
          description: Usuário para autenticação `BASIC`
        password:
          type: string
          description: Senha para autenticação `BASIC`
        headerName:
          type: string
          description: Nome do header para `CUSTOM_HEADER`
          example: X-Api-Key
        headerValue:
          type: string
          description: Valor do header para `CUSTOM_HEADER`
    WebhookResponse:
      type: object
      properties:
        id:
          type: string
          description: ID único do webhook
          example: A1B2C3D4E5F6789012345678901234AB
        channelId:
          type: string
          description: ID do canal ao qual o webhook pertence
          example: 019E4C54B1B375A28970B605CA9B03C3
        instanceId:
          type: string
          deprecated: true
          description: Descontinuado — use `channelId`
          example: 019E4C54B1B375A28970B605CA9B03C3
        url:
          type: string
          description: URL de destino dos eventos
          example: https://app.suaempresa.com/webhooks/hubmessage
        description:
          type: string
          nullable: true
          description: Descrição do webhook
          example: Webhook principal de produção
        events:
          type: array
          description: Tipos de evento configurados
          items:
            type: string
          example:
            - MESSAGE_RECEIVED
            - MESSAGE_STATUS
        status:
          type: string
          enum:
            - ENABLED
            - DISABLED
          description: Status atual do webhook
          example: ENABLED
        signing:
          type: boolean
          description: Indica se a assinatura HMAC está habilitada
          example: true
        auth:
          $ref: '#/components/schemas/WebhookAuthInfo'
        payloadFormat:
          type: string
          enum:
            - DEFAULT
          description: Formato do payload entregue
          example: DEFAULT
        customAttributes:
          type: object
          additionalProperties: true
          description: Atributos extras configurados
          example: {}
        createdAt:
          type: string
          format: date-time
          description: Data de criação
          example: 2025-01-15T10:30:00.000+0000
        updatedAt:
          type: string
          format: date-time
          description: Data da última atualização
          example: 2025-01-15T10:30:00.000+0000
    WebhookAuthInfo:
      type: object
      description: >-
        Resumo da autenticação configurada — credenciais não são retornadas por
        segurança
      properties:
        type:
          type: string
          enum:
            - NONE
            - BEARER
            - API_KEY
            - BASIC
            - CUSTOM_HEADER
          example: BEARER
        configured:
          type: boolean
          description: '`true` quando credenciais estão configuradas'
          example: true
  responses:
    Unauthorized:
      description: Token inválido ou ausente.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: 401
            message: Unauthorized
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Secret Key gerada no painel de Segurança do Hub Message

````