> ## Documentation Index
> Fetch the complete documentation index at: https://developers.datafyapi.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Configurar webhook global

> Cria ou substitui o webhook global da conta. O corpo define o webhook inteiro: os campos omitidos voltam ao valor padrão.

O webhook global é um destino único que recebe os eventos de **todos os canais** de WhatsApp da conta, sem precisar configurar um webhook em cada canal.

## Como funciona

* A conta tem **um** webhook global, apenas para WhatsApp.
* Ele funciona junto com os webhooks dos canais: um evento é entregue no webhook global e no webhook do canal. Se os dois apontam para a mesma URL, ela recebe o mesmo evento duas vezes, cada entrega assinada com o secret correspondente.
* As entregas são assinadas com o `secret` do próprio webhook global, no mesmo esquema de [assinatura](https://developers.datafyapi.com.br/api-reference/whatsapp/webhooks/validar-assinatura.md) dos webhooks dos canais. O secret é gerado na primeira configuração e mantido nas substituições seguintes; para trocá-lo, use [Rotacionar secret global](https://developers.datafyapi.com.br/api-reference/administracao/rotacionar-secret-global.md).

> [!WARNING]
>
> Diferente da edição dos webhooks dos canais, esta chamada substitui o webhook inteiro. Campos omitidos voltam ao valor padrão: `events` passa a ser `messages` e `smb_message_echoes`, e `enabled` passa a ser `true`.

## Resposta

| Campo | Descrição |
| - | - |
| `webhook.url` | URL que recebe os eventos de todos os canais |
| `webhook.events` | [Eventos](https://developers.datafyapi.com.br/api-reference/administracao/criar-webhook.md#eventos-disponíveis) que o webhook recebe |
| `webhook.enabled` | Indica se o webhook está ativo |
| `webhook.secret` | Secret usado na [assinatura](https://developers.datafyapi.com.br/api-reference/whatsapp/webhooks/validar-assinatura.md) das entregas deste webhook |


## OpenAPI

````yaml api-reference/administracao/specs/canais.json PUT /channels/whatsapp/global-webhook
openapi: 3.1.0
info:
  title: Datafy API — Administração de canais
  version: 1.0.0
servers:
  - url: https://cloud.datafyapi.com.br
    description: Produção
security:
  - tokenDeConta: []
paths:
  /channels/whatsapp/global-webhook:
    put:
      summary: Configurar webhook global
      description: >-
        Cria ou substitui o webhook global da conta. O corpo define o webhook
        inteiro: os campos omitidos voltam ao valor padrão.
      operationId: configurarWebhookGlobal
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - url
              properties:
                url:
                  type: string
                  example: https://exemplo.com/webhook-global
                  description: >-
                    URL que recebe os eventos de todos os canais. Precisa usar
                    HTTPS.
                events:
                  type: array
                  items:
                    type: string
                    enum:
                      - messages
                      - smb_message_echoes
                      - message_template_status_update
                      - message_template_quality_update
                      - message_template_components_update
                      - account_alerts
                      - account_update
                      - account_review_update
                      - account_settings_update
                      - phone_number_name_update
                      - phone_number_quality_update
                      - business_capability_update
                      - business_status_update
                      - template_category_update
                      - template_correct_category_detection
                      - flows
                      - calls
                      - security
                      - automatic_events
                      - tracking_events
                      - history
                      - smb_app_state_sync
                      - payment_configuration_update
                      - partner_solutions
                      - group_lifecycle_update
                      - group_participants_update
                      - group_settings_update
                      - group_status_update
                      - user_preferences
                  example:
                    - messages
                    - smb_message_echoes
                  description: >-
                    Eventos que o webhook recebe. Se omitido, recebe `messages`
                    e `smb_message_echoes`. Não pode ser uma lista vazia.
                enabled:
                  type: boolean
                  example: true
                  description: Ativa ou desativa o webhook. Se omitido, fica ativo.
            example:
              url: https://exemplo.com/webhook-global
              events:
                - messages
                - smb_message_echoes
              enabled: true
      responses:
        '200':
          description: Webhook global configurado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RespostaWebhookGlobal'
              example:
                webhook:
                  url: https://exemplo.com/webhook-global
                  events:
                    - messages
                    - smb_message_echoes
                  enabled: true
                  secret: whsec_xxx
        '400':
          description: Dados inválidos.
          content:
            application/json:
              examples:
                url_invalida:
                  summary: URL sem HTTPS
                  value:
                    statusCode: 400
                    message: URL inválida — precisa ser https://…
                events_nao_lista:
                  summary: events não é uma lista
                  value:
                    statusCode: 400
                    message: events deve ser uma lista de eventos
                events_vazio:
                  summary: events vazio
                  value:
                    statusCode: 400
                    message: >-
                      O webhook precisa de ao menos um evento (sem evento ele
                      nunca dispara)
                evento_inexistente:
                  summary: Evento inexistente
                  value:
                    statusCode: 400
                    message: 'Evento(s) inválido(s): mesages'
        '401':
          $ref: '#/components/responses/NaoAutorizado'
        '403':
          $ref: '#/components/responses/AssinaturaInativa'
components:
  schemas:
    RespostaWebhookGlobal:
      type: object
      properties:
        webhook:
          oneOf:
            - $ref: '#/components/schemas/WebhookGlobal'
            - type: 'null'
          description: Webhook global da conta, ou `null` quando não configurado.
    WebhookGlobal:
      type: object
      properties:
        url:
          type: string
          description: URL que recebe os eventos de todos os canais.
        events:
          type: array
          items:
            type: string
          description: Eventos que o webhook recebe.
        enabled:
          type: boolean
          description: Indica se o webhook está ativo.
        secret:
          type: string
          description: Secret usado na assinatura das entregas deste webhook.
  responses:
    NaoAutorizado:
      description: Token de conta ausente ou inválido.
      content:
        application/json:
          example:
            statusCode: 401
            message: Token de conta ausente ou inválido
    AssinaturaInativa:
      description: A assinatura da conta não está ativa.
      content:
        application/json:
          example:
            statusCode: 403
            message: >-
              Sua assinatura precisa estar ativa para usar a API. Acesse o
              painel para ativá-la.
  securitySchemes:
    tokenDeConta:
      type: http
      scheme: bearer
      description: >-
        Token de conta gerado no painel da Datafy, em Perfil. Formato:
        `sk_acct_xxx`. Diferente do token de canal (`sk_live_`).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.