PLplugsign

POST Retry failed webhooks

Changed on

Reenvia notificações de webhook com falha associadas a um documento, usando os webhooks cadastrados para a empresa do usuário autenticado. Informe o document_key no corpo da requisição.

A resposta informa o resultado de cada tentativa. Falhas de entrega são listadas em failed e nos itens com success: false.

post/api/webhooks/retry

Request

  • Base URL
    https://app.plugsign.com.br
  • URL
    https://app.plugsign.com.br/api/webhooks/retry
  • Auth
    API key in header Authorization

Request body

document_keystring required

Chave do documento cujas notificações de webhook devem ser reenviadas.

Response

messagestring

Resultado geral da operação.

totalinteger

Quantidade de tentativas incluídas em results.

successinteger

Quantidade de tentativas bem-sucedidas.

failedinteger

Quantidade de tentativas malsucedidas.

Example response

{
  "message": "Reenvio concluído",
  "total": 1,
  "success": 1,
  "results": [
    {
      "notification_id": 9876,
      "original_notification_id": 9123,
      "url": "https://example.com/webhook",
      "type": "FILE_UPLOADED",
      "retry_attempt": 2,
      "new_status": 200,
      "success": true
    }
  ]
}

Changes