Consultar inscrição
Retorna uma inscrição de webhook pelo id, com o status e os contadores de falha de entrega.
apiKeyAuthorizationBearer <token>Chave de API no header Authorization: Bearer <chave de API>.
id*stringid da inscrição, em ULID (26 caracteres).
Inscrição encontrada.
application/json- response
Inscrição com o total de eventos que não chegaram ao destino.
id*stringIdentificador da inscrição, em ULID.
ownerId*integerId da conta dona da inscrição. Vem da chave de API; não é enviado no corpo.
subscribedEvents*array<>Eventos que a inscrição recebe.
callbackUrl*stringURL que recebe os eventos.
uristatus*WebhookSubscriptionStatusactive: recebe eventos. paused: não recebe; volta com Ativar.
revoked: desligada.
"active""paused""revoked"failureCount*integerTentativas de entrega que falharam desde a última entrega com
sucesso. Conta cada nova tentativa, não cada evento; volta a 0 na
próxima entrega aceita.
lastFailureAt*|Data e hora (ISO 8601, UTC) da última falha de entrega, ou null.
date-timecreatedAt*stringData e hora de criação (ISO 8601, UTC).
date-timeupdatedAt*stringData e hora da última alteração (ISO 8601, UTC).
date-timeerrorEventsCount*integerEventos desta inscrição em erro: aguardando nova tentativa ou
que esgotaram as tentativas. Diferente de failureCount, conta
eventos, não tentativas. Só aparece em Listar e Consultar.
curl -X GET 'https://api.gates2b.com/webhook-subscriptions/string'{ "id": "01KTQRHR29PZ588RB1YQZWS4A6", "ownerId": 314, "subscribedEvents": [ "charge.paid", "charge.refunded", "payout.paid", "payout.failed" ], "callbackUrl": "https://loja.example.com/webhooks/pagamentos", "status": "active", "failureCount": 2, "lastFailureAt": "2026-06-16T09:12:44.000Z", "createdAt": "2026-06-15T14:00:00.000Z", "updatedAt": "2026-06-16T09:12:44.000Z", "errorEventsCount": 1}Regras
- Responde
404se oidnão existe e403se a inscrição é de outra conta. - O
secretnunca volta nesta consulta. Se perder o seu, use Rotacionar segredo. statuspausedsem você ter pausado indica que a URL foi recusada na hora da entrega. Corrija a URL com Atualizar inscrição e depois ative a inscrição.