Atualizar inscrição
Troca os eventos, a URL ou o status de uma inscrição, mantendo o mesmo segredo.
apiKeyAuthorizationBearer <token>Chave de API no header Authorization: Bearer <chave de API>.
id*stringid da inscrição, em ULID (26 caracteres).
application/json- body
Envie só os campos que quer mudar.
subscribedEvents?array<>Eventos que a inscrição recebe. Pelo menos um. A API não recusa um nome fora do catálogo, mas nenhum evento com esse nome é entregue: confira a grafia.
1 <= itemscallbackUrl?CallbackUrlURL que recebe os eventos. http ou https, endereço público com
domínio de topo (.com, .com.br…), nas portas 80, 443, 8080 ou 8443.
IP privado ou reservado, localhost e usuário/senha na URL são
recusados. Use https em produção.
urilength <= 2048status?WebhookSubscriptionStatusactive: recebe eventos. paused: não recebe; volta com Ativar.
revoked: desligada.
"active""paused""revoked"Inscrição atualizada.
application/json- response
Inscrição de webhook. Nunca inclui o secret.
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-timecurl -X PATCH 'https://api.gates2b.com/webhook-subscriptions/string' \ -H 'Content-Type: application/json' \ -d '{ "subscribedEvents": [ "charge.paid", "payout.paid", "payout.failed" ]}'{ "id": "01KTQRHR29PZ588RB1YQZWS4A6", "ownerId": 314, "subscribedEvents": [ "charge.paid", "payout.paid", "payout.failed" ], "callbackUrl": "https://loja.example.com/webhooks/pagamentos", "status": "active", "failureCount": 0, "lastFailureAt": null, "createdAt": "2026-06-15T14:00:00.000Z", "updatedAt": "2026-06-17T10:30:00.000Z"}Regras
- Só os campos enviados mudam. Um corpo vazio responde
200sem alterar nada. subscribedEventssubstitui a lista inteira, não acrescenta. Envie todos os eventos que quer manter.- Uma nova
callbackUrlpassa pela mesma validação da criação. statusaqui tem o mesmo efeito das rotas Pausar, Ativar e Revogar.- O
secretnão muda. Para trocá-lo, use Rotacionar segredo.