Skip to main content
PATCH
Ativar/desativar webhook
PATCH /webhooks/:id/status Faz parte do recurso Webhooks — o cadastro e o catálogo de eventos estão lá. Liga e desliga o webhook mantendo URL, eventos e secret. É o caminho certo para pausar as notificações durante uma manutenção do seu servidor, e o único jeito de reativar um webhook que a Z2Pay desativou sozinho.
Enquanto está inativo, os eventos não são guardados. Nada fica em fila esperando: o que acontecer nesse período simplesmente não vira entrega, e reativar não reenvia nada. Para fechar a lacuna depois, consulte a API pelos recursos daquele período — o passo a passo está em Entrega e retentativas.
Reativar limpa o autoDisabledAt. Se o webhook tinha sido desativado automaticamente por falhas, isActive: true o traz de volta e zera o marcador. Vale conferir que o endpoint já está respondendo 2xx antes — desativado de novo, o ciclo recomeça.

Exemplo

Resposta 200

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Headers

Idempotency-Key
string

Chave única para garantir idempotência da requisição

Path Parameters

id
string
required

ID do webhook

Body

application/json
isActive
boolean
required

Ativa (true) ou desativa (false) o webhook.

Response

Status do webhook atualizado

id
string
required

Identificador único do registro.

name
string
required

Nome do registro.

url
string<uri>
required

URL de destino do webhook ou link de download do arquivo.

events
string[]
required

Tipos de evento assinados pelo webhook.

isActive
boolean
required

Indica se o registro está ativo.

hasSecret
boolean
required
secretHint
string | null
required
autoDisabledAt
string<date-time> | null
required
createdAt
string<date-time>
required

Data e hora de criação do registro (ISO 8601).

updatedAt
string<date-time>
required

Data e hora da última atualização do registro (ISO 8601).