Webhooks

Configure webhooks para receber notificacoes HTTP em tempo real quando eventos ocorrem.

Para guia detalhado de implementacao, veja o Guia de Webhooks.

GET/api/v1/accounts/{account_id}/webhooks

Lista todos os webhooks configurados na conta.

bash

curl -s "https://chat.seudominio.com/api/v1/accounts/1/webhooks" \
  -H "api_access_token: YOUR_TOKEN" | jq .

200Lista de webhooks

json

{
  "payload": [
    {
      "id": 1,
      "account_id": 1,
      "url": "https://meuapp.com/webhooks/chat",
      "subscriptions": [
        "conversation_created",
        "message_created",
        "contact_created"
      ]
    }
  ]
}

POST/api/v1/accounts/{account_id}/webhooks

Registra um novo webhook para receber eventos.

Body

Nome	Tipo	Obrigatorio	Descricao
`url`	`string`	Sim	URL HTTPS que recebera os eventos via POST
`subscriptions`	`array`	Sim	Lista de eventos para receber

curl -X POST "https://chat.seudominio.com/api/v1/accounts/1/webhooks" \
  -H "api_access_token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://meuapp.com/webhooks/noovichat",
    "subscriptions": [
      "conversation_created",
      "conversation_status_changed",
      "message_created",
      "contact_created"
    ]
  }'

200Webhook criado

json

{
  "id": 2,
  "url": "https://meuapp.com/webhooks/noovichat",
  "subscriptions": ["conversation_created", "message_created"]
}

PATCH/api/v1/accounts/{account_id}/webhooks/{webhook_id}

Atualiza a URL ou subscriptions de um webhook.

Body

Nome	Tipo	Obrigatorio	Descricao
`url`	`string`	Nao	Nova URL do webhook
`subscriptions`	`array`	Nao	Nova lista de eventos

bash

curl -X PATCH "https://chat.seudominio.com/api/v1/accounts/1/webhooks/2" \
  -H "api_access_token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "subscriptions": [
      "conversation_created",
      "message_created",
      "contact_updated"
    ]
  }'

DELETE/api/v1/accounts/{account_id}/webhooks/{webhook_id}

Remove um webhook. Eventos nao serao mais enviados para a URL.

bash

curl -X DELETE "https://chat.seudominio.com/api/v1/accounts/1/webhooks/2" \
  -H "api_access_token: YOUR_TOKEN"

Eventos Disponiveis

Evento	Descricao
`conversation_created`	Nova conversa criada
`conversation_status_changed`	Status da conversa alterado
`message_created`	Nova mensagem recebida ou enviada
`message_updated`	Mensagem atualizada
`contact_created`	Novo contato criado
`contact_updated`	Dados do contato atualizados
`webwidget_triggered`	Widget de chat acionado no site

Payload do Webhook

Cada evento envia um payload JSON com os dados do evento. O campo event identifica o tipo de evento. Veja exemplos no Guia de Webhooks.