ZaplinDocs
GuiasReferência da APIMCPChangelogAbrir o app

Criar webhook

POST
/v1/webhooks

Cria um endpoint de webhook de saída para eventos como message.received; o segredo de assinatura volta uma única vez.

Escopo: webhooks:write

Autorização

bearer webhooks:write
headerAutorizaçãoBearer <token>

A chave de API de uma conta de serviço (sk_live_…, 600 requisições por minuto cada) ou um access token OAuth para o recurso /api/v1 (600 requisições por minuto por conexão).

Escopo: webhooks:write

Cabeçalhos

Idempotency-Key?string

Até 200 letras, dígitos, - ou _. A primeira resposta a uma chave é repetida por 24 horas.

Tamanholength <= 200

Corpo da requisição

application/json
  1. body
name?string
Tamanholength <= 80
url*string
Tamanholength <= 2000
events*array<>
Itensitems <= 50

Corpo da resposta

Feito.

application/json
  1. response
id*string
secret*string
Exemplo de requisição
curl -X POST 'https://app.zaplin.com.br/api/v1/webhooks' \  -H 'Authorization: Bearer sk_live_...' \  -H 'Content-Type: application/json' \  -d '{  "url": "string",  "events": [    "string"  ]}'
Exemplo de resposta
{  "id": "string",  "secret": "string"}