MCP: Webhooks
Create, edit and monitor the workspace webhooks through the MCP. 6 tools.
Tools in this area, generated from the server code. The descriptions come from that code, in Portuguese. To connect, see the XBASE MCP.
create-webhook
Cadastra um webhook: a URL (https, pública) passa a receber em tempo real os eventos escolhidos dos números escolhidos. Devolve o segredo de assinatura UMA vez (guarde). Até 10 webhooks por workspace.
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
name | yes | — |
url | yes | — |
events | yes | Eventos: whatsapp.message.received (mensagem recebida), whatsapp.message.sent/delivered/read/failed (status das enviadas), instagram.comment e instagram.message |
format | yes | Formato do corpo: XBASE (padrão), com o número e o evento, assinado no cabeçalho x-xbase-signature |
connectionIds | no | Números de WhatsApp cobertos (veja list-webhook-numbers); vazio = todos |
delete-webhook
Exclui um webhook do workspace e o log de entregas dele. Não tem volta (para pausar, use update-webhook com enabled=false).
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
webhookId | yes | ID do webhook (veja list-webhooks) |
list-webhook-deliveries
Últimas 20 entregas de um webhook: evento, status (PENDING/DELIVERED/FAILED), tentativas, status HTTP e erro.
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
webhookId | yes | ID do webhook (veja list-webhooks) |
list-webhook-numbers
Lista os números de WhatsApp do workspace que um webhook pode cobrir, com o connectionId a usar em create-webhook.
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
list-webhooks
Lista os webhooks do workspace (Integrações → Webhooks): URL, eventos, formato, números, ligado/desligado e a última entrega.
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
update-webhook
Altera um webhook do workspace (só os campos enviados): nome, URL, eventos, formato, números ou ligado/desligado (enabled).
| Parameter | Required | Description |
|---|---|---|
workspaceId | no | Opcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial) |
webhookId | yes | ID do webhook (veja list-webhooks) |
name | no | — |
url | no | — |
events | no | Eventos: whatsapp.message.received (mensagem recebida), whatsapp.message.sent/delivered/read/failed (status das enviadas), instagram.comment e instagram.message |
format | no | Formato do corpo: XBASE (padrão), com o número e o evento, assinado no cabeçalho x-xbase-signature |
connectionIds | no | Números de WhatsApp cobertos (veja list-webhook-numbers); vazio = todos |
enabled | no | false desliga o webhook sem apagar |