Criar ou atualizar webhook

Amb. de Desenv.

http://localhost:3000

POST

/instances/{instanceId}/webhooks

Cria ou atualiza um webhook da instância informada.

Use esta rota para informar em qual URL o seu sistema deve receber os eventos dessa instância.

Regras:

o webhook é configurado por instância

cada instância pode ter um webhook por evento

se o evento já existir, a URL é atualizada

eventos disponíveis: message.sent, message.received e message.failed

a URL deve ser pública em http/https

Esquemas úteis para leitura do contrato:

MessageSentWebhookPayload

MessageFailedWebhookPayload

InboundWebhookPayload

WebhookPayload

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 'http://localhost:3000/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-06-12 15:08:32

Página anterior

Enviar mensagem de texto

Próxima página

Desativar webhook