> ## 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.

# Consultar webhook global

> Retorna o webhook global da conta, que recebe os eventos de todos os canais.

## 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 |

Quando a conta não tem webhook global, a resposta é `{ "webhook": null }`.


## OpenAPI

````yaml api-reference/administracao/specs/canais.json GET /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:
    get:
      summary: Consultar webhook global
      description: >-
        Retorna o webhook global da conta, que recebe os eventos de todos os
        canais.
      operationId: consultarWebhookGlobal
      responses:
        '200':
          description: Webhook global da conta.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RespostaWebhookGlobal'
              examples:
                configurado:
                  summary: Webhook configurado
                  value:
                    webhook:
                      url: https://exemplo.com/webhook-global
                      events:
                        - messages
                        - smb_message_echoes
                      enabled: true
                      secret: whsec_xxx
                nao_configurado:
                  summary: Sem webhook global
                  value:
                    webhook: null
        '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.