> ## 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/instagram/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`.

| Evento | Descrição |
| - | - |
| [`messages`](https://developers.datafyapi.com.br/api-reference/instagram/webhooks/eventos/mensagens) | Mensagem recebida no direct, incluindo as mensagens que a própria conta envia (`is_echo`) |
| [`messaging_postbacks`](https://developers.datafyapi.com.br/api-reference/instagram/webhooks/eventos/postbacks) | Clique em botão de resposta rápida ou ice breaker |
| [`messaging_referral`](https://developers.datafyapi.com.br/api-reference/instagram/webhooks/eventos/outros) | Conversa aberta por link `ig.me` com parâmetro `ref` |
| [`messaging_seen`](https://developers.datafyapi.com.br/api-reference/instagram/webhooks/eventos/leitura) | Confirmação de leitura das mensagens enviadas |
| [`message_reactions`](https://developers.datafyapi.com.br/api-reference/instagram/webhooks/eventos/reacoes) | Reação adicionada ou removida em uma mensagem |
| [`message_edit`](https://developers.datafyapi.com.br/api-reference/instagram/webhooks/eventos/outros) | Mensagem editada pelo remetente |
| [`messaging_optins`](https://developers.datafyapi.com.br/api-reference/instagram/webhooks/eventos/outros) | Opt-in de notification messages, que permite enviar fora da janela de 24 horas |
| [`messaging_handover`](https://developers.datafyapi.com.br/api-reference/instagram/webhooks/eventos/outros) | Passagem de controle da conversa entre aplicativos |
| [`standby`](https://developers.datafyapi.com.br/api-reference/instagram/webhooks/eventos/outros) | Mensagens que chegam enquanto outro aplicativo tem o controle da conversa |
| [`comments`](https://developers.datafyapi.com.br/api-reference/instagram/webhooks/eventos/comentarios) | Comentários em posts e reels da conta |
| [`live_comments`](https://developers.datafyapi.com.br/api-reference/instagram/webhooks/eventos/comentarios) | Comentários durante uma transmissão ao vivo |


## OpenAPI

````yaml api-reference/instagram/administracao/specs/canais.json POST /channels/instagram/{id}/webhooks
openapi: 3.1.0
info:
  title: Datafy API — Administração de canais do Instagram
  version: 1.0.0
servers:
  - url: https://cloud.datafyapi.com.br
    description: Produção
security:
  - tokenDeConta: []
paths:
  /channels/instagram/{id}/webhooks:
    post:
      summary: Criar webhook
      description: Cadastra uma URL para receber os eventos do canal.
      operationId: criarWebhookInstagram
      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:
                    $ref: '#/components/schemas/EventoInstagram'
                  example:
                    - messages
                  description: >-
                    Eventos que o webhook recebe. Se omitido, recebe `messages`.
                    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_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:
    EventoInstagram:
      type: string
      enum:
        - messages
        - messaging_postbacks
        - messaging_referral
        - messaging_seen
        - message_reactions
        - message_edit
        - messaging_optins
        - messaging_handover
        - standby
        - comments
        - live_comments
    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, na aba Parceiros. 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.