API y webhooks

MCP: Webhooks

Registrar, editar y seguir los webhooks del workspace por el MCP. 6 herramientas.

Herramientas de esta área, generadas del código del servidor. Las descripciones vienen de ese código, en portugués. Para conectar, mira el MCP de XBASE.

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.

ParámetroObligatorioDescripción
workspaceIdnoOpcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
namesí—
urlsí—
eventssíEventos: whatsapp.message.received (mensagem recebida), whatsapp.message.sent/delivered/read/failed (status das enviadas), instagram.comment e instagram.message
formatsíFormato do corpo: XBASE (padrão), com o número e o evento, assinado no cabeçalho x-xbase-signature
connectionIdsnoNú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).

ParámetroObligatorioDescripción
workspaceIdnoOpcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
webhookIdsí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.

ParámetroObligatorioDescripción
workspaceIdnoOpcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
webhookIdsí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.

ParámetroObligatorioDescripción
workspaceIdnoOpcional: 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.

ParámetroObligatorioDescripción
workspaceIdnoOpcional: 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).

ParámetroObligatorioDescripción
workspaceIdnoOpcional: só é aceito se for o workspace do token (o workspace vem sempre da credencial)
webhookIdsíID do webhook (veja list-webhooks)
nameno—
urlno—
eventsnoEventos: whatsapp.message.received (mensagem recebida), whatsapp.message.sent/delivered/read/failed (status das enviadas), instagram.comment e instagram.message
formatnoFormato do corpo: XBASE (padrão), com o número e o evento, assinado no cabeçalho x-xbase-signature
connectionIdsnoNúmeros de WhatsApp cobertos (veja list-webhook-numbers); vazio = todos
enablednofalse desliga o webhook sem apagar

En esta página