> ## 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. # Criar webhook > Cadastra uma URL para receber os eventos do canal. ## Resposta | Campo | Descrição | | - | - | | `id` | ID do webhook | | `url` | URL que recebe os eventos | | `events` | [Eventos](https://developers.datafyapi.com.br/api-reference/whatsapp/webhooks/receber-eventos.md) que o webhook recebe | | `enabled` | Indica se o webhook está ativo | ## Eventos disponíveis Valores aceitos em `events`. Se o campo não for enviado, o webhook recebe `messages` e `smb_message_echoes`. | Evento | Descrição | | - | - | | [`messages`](https://developers.datafyapi.com.br/api-reference/whatsapp/webhooks/eventos/mensagens) | Mensagens recebidas e status de entrega | | [`smb_message_echoes`](https://developers.datafyapi.com.br/api-reference/whatsapp/webhooks/eventos/mensagens-do-celular) | Mensagens enviadas pelo aplicativo ou pelo WhatsApp Web | | [`message_template_status_update`](https://developers.datafyapi.com.br/api-reference/whatsapp/webhooks/eventos/templates) | Aprovação ou reprovação de templates | | [`message_template_quality_update`](https://developers.datafyapi.com.br/api-reference/whatsapp/webhooks/eventos/templates) | Mudanças na qualidade dos templates | | [`message_template_components_update`](https://developers.datafyapi.com.br/api-reference/whatsapp/webhooks/eventos/templates) | Atualizações nos componentes de templates | | [`account_alerts`](https://developers.datafyapi.com.br/api-reference/whatsapp/webhooks/eventos/conta) | Alertas da conta (qualidade, aprovações, bloqueios) | | [`account_update`](https://developers.datafyapi.com.br/api-reference/whatsapp/webhooks/eventos/conta) | Atualizações gerais da conta do WhatsApp Business | | `account_review_update` | Atualizações no processo de revisão da conta | | `account_settings_update` | Mudanças nas configurações da conta | | `phone_number_name_update` | Mudanças no nome do número de telefone | | [`phone_number_quality_update`](https://developers.datafyapi.com.br/api-reference/whatsapp/webhooks/eventos/qualidade-do-numero) | Atualizações na qualidade do número | | `business_capability_update` | Mudanças nas capacidades do negócio | | `business_status_update` | Atualizações no status do negócio | | [`template_category_update`](https://developers.datafyapi.com.br/api-reference/whatsapp/webhooks/eventos/templates) | Reclassificação de categoria de templates | | `template_correct_category_detection` | Detecção de categoria correta em templates | | `flows` | Eventos relacionados aos WhatsApp Flows | | `calls` | Chamadas de voz iniciadas pelos usuários | | `security` | Eventos de segurança da conta | | `automatic_events` | Eventos automáticos do sistema | | `tracking_events` | Eventos de rastreamento | | [`history`](https://developers.datafyapi.com.br/api-reference/whatsapp/webhooks/eventos/historico) | Histórico de conversas, na sincronização da coexistência | | [`smb_app_state_sync`](https://developers.datafyapi.com.br/api-reference/whatsapp/webhooks/eventos/contatos-sincronizados) | Contatos do aplicativo, na sincronização da coexistência | | `payment_configuration_update` | Atualizações na configuração de pagamentos | | `partner_solutions` | Soluções de parceiros integradas | | `group_lifecycle_update` | Ciclo de vida de grupos (criação, encerramento) | | `group_participants_update` | Entrada e saída de participantes em grupos | | `group_settings_update` | Mudanças nas configurações de grupos | | `group_status_update` | Atualizações de status de grupos | | `user_preferences` | Preferências e configurações dos usuários | ## OpenAPI ````yaml api-reference/administracao/specs/canais.json POST /channels/whatsapp/{id}/webhooks 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/{id}/webhooks: post: summary: Criar webhook description: Cadastra uma URL para receber os eventos do canal. operationId: criarWebhook parameters: - $ref: '#/components/parameters/CanalId' requestBody: required: true content: application/json: schema: type: object required: - url properties: url: type: string example: https://exemplo.com/webhook description: URL que recebe os eventos. 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 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 default: true description: Ativa ou desativa o webhook. example: url: https://exemplo.com/webhook events: - messages enabled: true responses: '200': description: Webhook criado. content: application/json: schema: $ref: '#/components/schemas/WebhookResposta' example: id: 9d8c7b6a-5f4e-4d3c-2b1a-0f9e8d7c6b5a url: https://exemplo.com/webhook events: - messages enabled: true '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' '404': $ref: '#/components/responses/CanalNaoEncontrado' components: parameters: CanalId: name: id in: path required: true schema: type: string description: ID do canal, retornado em Listar canais e em Criar canal. schemas: WebhookResposta: type: object properties: id: type: string description: ID do webhook. url: type: string description: URL que recebe os eventos. events: type: array items: type: string description: Eventos que o webhook recebe. enabled: type: boolean description: Indica se o webhook está ativo. 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. CanalNaoEncontrado: description: Canal inexistente ou de outra conta. content: application/json: example: statusCode: 404 message: Canal não encontrado 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.