Register a webhook

POST

/webhooks

Requires webhooks:write. Registers a webhook for the integration that owns the token and returns its signing secret once. An integration holds at most 5 webhooks (422 webhook_limit_reached); a non-HTTPS or non-public URL answers 422 webhook_url_unsafe. A webhook belongs to the integration, not to the key: revoking the key does not remove it — delete the webhook too. Since 1.46.

Requisição

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201Criado

application/json

Created

Bodyapplication/json

🟠401Não Autorizado

🟠403Proibido

🟠422Erro de Parâmetro

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location '/webhooks' \
--header 'Content-Type: application/json' \
--data '{
    "url": "https://erp.example.com/wazapi/webhook",
    "events": [
        "message.received",
        "message.send.failed"
    ]
}'

Response Example

201 - Exemplo 1

{
    "data": {
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "url": "http://example.com",
        "events": [
            "message.received"
        ],
        "active": true,
        "secret_hint": "whsec_••••9f3a",
        "previous_secret_expires_at": "2019-08-24T14:15:22.123Z",
        "created_at": "2019-08-24T14:15:22.123Z",
        "updated_at": "2019-08-24T14:15:22.123Z",
        "secret": "string"
    }
}

Modificado em 2026-10-22 18:13:52

Página anterior

List the integration webhooks

Próxima página

Replace a webhook URL and events