Pausar inscrição
Interrompe a entrega de eventos para a inscrição sem apagá-la; reative quando quiser.
apiKeyAuthorizationBearer <token>Chave de API no header Authorization: Bearer <chave de API>.
id*stringid da inscrição, em ULID (26 caracteres).
Inscrição pausada.
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 POST 'https://api.gates2b.com/webhook-subscriptions/string/pause'{ "id": "01KTQRHR29PZ588RB1YQZWS4A6", "ownerId": 314, "subscribedEvents": [ "charge.paid", "charge.refunded", "payout.paid", "payout.failed" ], "callbackUrl": "https://loja.example.com/webhooks/pagamentos", "status": "paused", "failureCount": 0, "lastFailureAt": null, "createdAt": "2026-06-15T14:00:00.000Z", "updatedAt": "2026-06-18T08:00:00.000Z"}Eventos não ficam guardados durante a pausa. Uma nova tentativa que vencer durante a pausa é descartada, e os eventos
gerados enquanto a inscrição está paused nunca são entregues, nem depois de ativar. Consulte
pela API o que mudou nesse intervalo.
Regras
- Use para manutenção do seu endpoint. Para desligar a URL de vez, use Revogar inscrição.
- A Gates2b também pausa a inscrição quando a URL é recusada na hora da entrega (endereço privado ou porta não permitida).
- Os status possíveis e o que muda em cada um estão em Status da inscrição.