Webhooks
Criar webhook
Cria um destino HTTPS e revela o segredo uma única vez.
POST
/webhookswebhooks:writeCOMPORTAMENTO
A alteração é validada e persistida na conta da chave antes da resposta. Consulte o recurso retornado como fonte de verdade.
EFEITO
Pode alterar o recurso e emitir o evento de domínio correspondente.
REPETIÇÃO
Em falha de rede, confirme o estado do recurso antes de repetir. Refaça automaticamente apenas 429 e 5xx com backoff e jitter.
Solicitação
namestring · bodyNome do destino.obrigatóriourlstring · bodyURL HTTPS pública.uriobrigatórioeventsarray · bodyEventos ou *.obrigatórioactiveboolean · bodyAtiva o destino.opcionalAuthorization
Bearer ach_live_...Accept
application/jsonEscopo
webhooks:writeExemplo executável
curl
curl -X POST 'https://achadu.com/api/v1/webhooks' \
-H 'Authorization: Bearer ach_live_...' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
--data '{
"name": "My integration",
"url": "https://example.com/product",
"events": [
"offer.created"
],
"active": true
}'Resposta e erros
Toda resposta inclui request_id. Listas acrescentam pagination; recursos mutáveis retornam o estado persistido após a operação.
201 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"
},
"created": true,
"request_id": "req_01J..."
}201Recurso criado e persistido.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:write.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.