Pular para o conteúdo
AchaduDevelopers
API operacionalIr para o site
Painel
Developers/API/webhook_event_schema
Webhooks

Ver schema de evento

Retorna o JSON Schema e um exemplo do evento na versão atual.

GET/webhook-events/{event}/schemawebhooks:read
COMPORTAMENTO

A leitura busca o identificador dentro da conta vinculada à chave e retorna 404 quando ele não pertence à operação.

EFEITO

Não altera recursos nem dispara publicação.

REPETIÇÃO

A operação é segura para repetição. Em 429 ou 5xx, use backoff exponencial com jitter.

Solicitação

eventstring · pathNome completo do evento.obrigatório
AuthorizationBearer ach_live_...
Acceptapplication/json
Escopowebhooks:read

Exemplo executável

curl
curl 'https://achadu.com/api/v1/webhook-events/string/schema' \
  -H 'Authorization: Bearer ach_live_...' \
  -H 'Accept: application/json'

Resposta e erros

Toda resposta inclui request_id. Listas acrescentam pagination; recursos mutáveis retornam o estado persistido após a operação.

200 application/json
{
  "data": {
    "id": "wh_01J...",
    "name": "Production",
    "url": "https://example.com/webhooks/achadu",
    "events": [
      "offer.created"
    ],
    "active": true,
    "created_at": "2026-08-31T18:20:00.000Z"
  },
  "request_id": "req_01J..."
}
200Operação concluída.
400Parâmetro, corpo ou transição inválida.
401Chave ausente, inválida, expirada ou revogada.
402O plano da conta não libera esta interface.
403A chave precisa do escopo webhooks:read.
404Recurso inexistente nesta conta.
409O estado atual impede esta operação.
413O corpo JSON ultrapassa 128 KB.
429A janela de 120 solicitações por minuto foi excedida.