Skip to main content
Webhooks entregam eventos via POST para a URL que você configurar. Cada webhook tem um hmac_secret usado para assinar as entregas — guarde-o para verificar a autenticidade dos eventos recebidos.

Tipo WebhookConfig

Endpoints

Listar webhooks

Resposta: WebhookConfig[]

Criar webhook

string
required
Nome identificador
string
required
URL do seu endpoint. Deve começar com https://.
string[]
required
Eventos a receber. Valores: messages, message_status.
string[]
IDs dos canais a filtrar. Se omitido, recebe eventos de todos os canais da org.
Resposta: WebhookConfig — status 201 Created
Salve o hmac_secret retornado imediatamente. Ele não pode ser recuperado depois. Se for perdido, delete e recrie o webhook.

Buscar webhook


Pausar / reativar webhook

string
required
"active" ou "paused"

Deletar webhook

Resposta: 204 No Content

Atribuir canal ao webhook

Operação idempotente — seguro chamar múltiplas vezes. Resposta: { webhook_config_id: string, channel_id: string }

Remover canal do webhook

Resposta: 204 No Content

Retry automático

O Coexy tenta reenviar eventos em caso de falha: Seu endpoint tem 10 segundos para responder com status 2xx. Responda sempre antes de processar — veja Segurança.

Erros