Referencia apiWebhooks
Webhook Novo
POST
POST /v1/webhooks. Contrato do handler webhookNovo. Requer autenticação e autorização no contexto da conta; permissões e suspensão podem impedir a operação.
bearerAuthheader
AutorizaçãoBearer <token>JWT de usuário/console ou API token, conforme a autorização e as permissões da conta. Não enviar tokens reais nos exemplos.
application/json- body
endpoint?stringevents?array<string>name?stringtoken?stringuseAuthentication?booleanOperação concluída.
application/json- response
createdAt?stringFormato
date-timeenabled?booleanendpoint?stringevents?array<string>name?stringtoken?stringtype?stringupdatedAt?stringFormato
date-timeuseAuthentication?booleanwebhookId?stringcurl -X POST "https://example.com/v1/webhooks" \ -H "Content-Type: application/json" \ -d '{ "endpoint": "", "events": [], "name": "Exemplo sintético", "token": "", "useAuthentication": false }'{ "createdAt": "2026-01-15T12:00:00Z", "enabled": false, "endpoint": "", "events": [], "name": "Exemplo sintético", "token": "", "type": "", "updatedAt": "2026-01-15T12:00:00Z", "useAuthentication": false, "webhookId": "0123456789abcdef01234567"}Webhook Listar GET
GET /v1/webhooks. Contrato do handler webhookListar. Requer autenticação e autorização no contexto da conta; permissões e suspensão podem impedir a operação.
Webhook Listar Eventos GET
GET /v1/webhooks/list-event-types. Contrato do handler webhookListarEventos. Requer autenticação e autorização no contexto da conta; permissões e suspensão podem impedir a operação.