Criar ou atualizar webhook

Amb. de Produção

https://api.way-api.io

POST

/instances/{instanceId}/webhooks

Última modificação:2026-09-17 22:00:23

Define a URL que receberá um tipo de evento desta instância.

Cada instância pode ter uma URL para cada evento. Se o evento já estiver cadastrado, esta operação
substitui a URL anterior e reativa o envio.

Escolha o evento em eventType:

message.sent: uma mensagem saiu da fila e foi processada com sucesso;

message.failed: o envio de uma mensagem falhou;

message.received: a conta conectada recebeu uma mensagem ou um evento do WhatsApp.

A URL deve ser pública e usar http ou https. Quando o evento acontecer, a WayAPI fará um POST
com JSON para essa URL. Responda rapidamente com um status 2xx e processe tarefas demoradas depois.
Entregas duplicadas podem ocorrer, então use messageId ou externalId para ignorar repetições.

Consulte WebhookPayload na seção de schemas para ver todos os formatos, com exemplos.

Requisição

Authorization

Adicionar parâmetro em header

x-api-key

Exemplo:

x-api-key: ********************

Parâmetros de Caminho

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200OK

application/json

The request has succeeded.

Bodyapplication/json

🟠400Requisição Inválida

🟠401Não Autorizado

🟠403Proibido

🟠404Registo Não Encontrado

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.way-api.io/instances//webhooks' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "eventType": "message.received",
    "url": "https://meusistema.com.br/webhooks/wayapi"
}'

Response Example

200 - Webhook criado/atualizado

{
    "eventType": "message.received",
    "url": "https://api.suaempresa.com.br/integracoes/wayapi/webhook"
}

Modificado em 2026-09-17 22:00:23

Próxima página

Desativar webhook