Gates2b

Revogar inscrição

Desliga a inscrição e para na hora todas as entregas, inclusive as tentativas pendentes.

POST
/webhook-subscriptions/{id}/revoke

Authorization

apiKey
headerAuthorizationBearer <token>

Chave de API no header Authorization: Bearer <chave de API>.

Path Parameters

id*string

id da inscrição, em ULID (26 caracteres).

Response Body

Inscrição revogada.

application/json
  1. response

Inscrição de webhook. Nunca inclui o secret.

id*string

Identificador da inscrição, em ULID.

ownerId*integer

Id 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*string

URL que recebe os eventos.

Formatouri
status*WebhookSubscriptionStatus

active: recebe eventos. paused: não recebe; volta com Ativar. revoked: desligada.

Valores aceitos"active""paused""revoked"
failureCount*integer

Tentativas 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.

Formatodate-time
createdAt*string

Data e hora de criação (ISO 8601, UTC).

Formatodate-time
updatedAt*string

Data e hora da última alteração (ISO 8601, UTC).

Formatodate-time
Example Request
curl -X POST 'https://api.gates2b.com/webhook-subscriptions/string/revoke'
Example Response
{  "id": "01KTQRHR29PZ588RB1YQZWS4A6",  "ownerId": 314,  "subscribedEvents": [    "charge.paid",    "charge.refunded",    "payout.paid",    "payout.failed"  ],  "callbackUrl": "https://loja.example.com/webhooks/pagamentos",  "status": "revoked",  "failureCount": 0,  "lastFailureAt": null,  "createdAt": "2026-06-15T14:00:00.000Z",  "updatedAt": "2026-06-18T10:00:00.000Z"}

Regras

  • Use quando a URL deixar de existir ou o secret tiver vazado. Para uma interrupção temporária, use Pausar inscrição.
  • Tentativas pendentes são descartadas e eventos novos não são gerados para a inscrição.
  • A inscrição continua aparecendo em Listar inscrições, com status revoked.
  • Depois de revogar, cadastre a nova URL com Criar inscrição. Ela recebe um secret novo.

Nesta página