Skip to main content
POST
Reprocessar delivery
POST /webhooks/deliveries/:id/retry Faz parte do recurso Webhooks — o cadastro e o catálogo de eventos estão lá. Reenvia uma entrega para a URL atual do webhook. O caso de uso é o de sempre: seu endpoint esteve fora do ar, você corrigiu, e agora quer receber o que ficou para trás. Responde 200 com a entrega relida depois do reenvio.
Só entregas concluídas. failed é o caso normal; success também é aceito, para quando você processou mal e quer o evento de novo. As que ainda estão em curso (pending, retrying) respondem 409 DELIVERY_ALREADY_RUNNING — a Z2Pay já vai reenviá-las sozinha, sem você pedir.
O reenvio é assíncrono: o status da resposta ainda pode ser retrying. A entrega é reenfileirada e relida logo em seguida, então o corpo mostra o estado imediato, não necessariamente o desfecho. Para saber como terminou, consulte a entrega alguns instantes depois.
O corpo reenviado é o original, sem alterações — mesmo id, mesmo occurredAt. Se o recurso mudou de estado desde então, o payload continua descrevendo o momento do evento, não o de agora. Um receptor que trate o webhook como aviso e consulte a API pelo id não se incomoda com isso.

Limites e recusas

Cada entrega tem 12 tentativas no total: as 7 do ciclo automático mais 5 reprocessamentos manuais. O reenvio recusa com código próprio, para você distinguir o que fazer:

Exemplo

Resposta 200
Os campos de resultado ainda são os da tentativa anterior — eles só mudam quando a nova tentativa termina.

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 da delivery

Response

Entrega reenviada, com o resultado da nova tentativa

id
string

Identificador único do registro.

webhookId
string

ID do webhook relacionado ao registro.

eventType
string

Tipo do evento entregue (ex.: transaction.paid).

url
string

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

payload
object

Conteúdo (payload) enviado na entrega do webhook.

status
string

Situação da entrega. Valores: pending, success, failed, retrying.

attemptCount
integer

Número de tentativas de entrega já realizadas.

returnStatus
integer | null

Código de status HTTP retornado pelo endpoint na entrega.

returnData
object | null

Corpo da resposta retornada pelo endpoint na entrega.

errorMessage
string | null

Mensagem de erro quando o processamento falha.

lastAttemptAt
string<date-time> | null

Data e hora da última tentativa de entrega (ISO 8601).

createdAt
string<date-time>

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

updatedAt
string<date-time>

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