InícioReferência da API
Referencia apiWebhooks

Webhook Atualizar

PATCH
/v1/webhooks/{webhook_id}

PATCH /v1/webhooks/{webhook_id}. Contrato do handler webhookAtualizar. Requer autenticação e autorização no contexto da conta; permissões e suspensão podem impedir a operação.

Autorização

bearerAuth
headerAutorizaçã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.

Parâmetros de path

webhook_id*string

Identificador utilizado pelo handler.

Corpo da requisição

application/json
  1. body
AtualizadoEm?string
Formatodate-time
Tipo?string
enabled?boolean
endpoint?string
events?array<string>
name?string
token?string
useAuthentication?boolean

Corpo da resposta

Operação concluída.

application/json
  1. response
createdAt?string
Formatodate-time
enabled?boolean
endpoint?string
events?array<string>
name?string
token?string
type?string
updatedAt?string
Formatodate-time
useAuthentication?boolean
webhookId?string
curl -X PATCH "https://example.com/v1/webhooks/0123456789abcdef01234567" \  -H "Content-Type: application/json" \  -d '{    "AtualizadoEm": "2026-01-15T12:00:00Z",    "Tipo": "",    "enabled": false,    "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 Buscar GET

GET /v1/webhooks/{webhook_id}. Contrato do handler webhookBuscar. Requer autenticação e autorização no contexto da conta; permissões e suspensão podem impedir a operação.

Webhook Deletar DELETE

DELETE /v1/webhooks/{webhook_id}. Contrato do handler webhookDeletar. Requer autenticação e autorização no contexto da conta; permissões e suspensão podem impedir a operação.