Logs de Entrega

Monitore o historico de entregas dos seus webhooks, verifique falhas e reenvie notificacoes quando necessario.

---

Listar logs de entrega

Retorna o historico de tentativas de entrega de um webhook.

Requisicao

GET /v1/webhooks/{webhookId}/logs

URL completa: https://api.tapsign.com.br/v1/webhooks/{webhookId}/logs

Headers

Header	Valor
Authorization	Bearer {token}

Query parameters

Parametro	Tipo	Obrigatorio	Descricao
page	integer	Nao	Numero da pagina. Default: 0
size	integer	Nao	Itens por pagina. Default: 20. Max: 100
status	string	Nao	Filtrar por status: SUCCESS, FAILED, PENDING
eventType	string	Nao	Filtrar por tipo de evento (ex: signer.signed)
dateFrom	string	Nao	Data inicial (ISO 8601)
dateTo	string	Nao	Data final (ISO 8601)

Exemplo de requisicao

curl -X GET "https://api.tapsign.com.br/v1/webhooks/wh_abc123def456/logs?page=0&size=10&status=FAILED" \
  -H "Authorization: Bearer {token}"

Resposta

Status: 200 OK

{
  "content": [
    {
      "id": "log_001",
      "webhookId": "wh_abc123def456",
      "eventId": "evt_sgn_signed_001",
      "eventType": "signer.signed",
      "status": "FAILED",
      "statusCode": 500,
      "attemptNumber": 3,
      "sentAt": "2026-03-29T15:35:00Z",
      "responseTime": 2340,
      "responseBody": "Internal Server Error",
      "nextRetryAt": "2026-03-29T16:05:00Z"
    },
    {
      "id": "log_002",
      "webhookId": "wh_abc123def456",
      "eventId": "evt_env_completed_001",
      "eventType": "envelope.completed",
      "status": "SUCCESS",
      "statusCode": 200,
      "attemptNumber": 1,
      "sentAt": "2026-03-29T16:00:05Z",
      "responseTime": 156,
      "responseBody": null,
      "nextRetryAt": null
    }
  ],
  "page": 0,
  "size": 10,
  "totalElements": 2,
  "totalPages": 1
}

Campos do log

Campo	Tipo	Descricao
id	string	Identificador unico do log
webhookId	string	ID do webhook
eventId	string	ID do evento original
eventType	string	Tipo do evento
status	string	SUCCESS, FAILED ou PENDING
statusCode	integer	Codigo HTTP retornado pelo seu servidor
attemptNumber	integer	Numero da tentativa (1 a 5)
sentAt	string	Data/hora do envio (ISO 8601)
responseTime	integer	Tempo de resposta em milissegundos
responseBody	string	Corpo da resposta (truncado em 1KB)
nextRetryAt	string	Proxima tentativa agendada (se houver)

---

Reenviar entrega

Reenvia manualmente uma notificacao que falhou.

Requisicao

POST /v1/webhooks/{webhookId}/logs/{logId}/retry

URL completa: https://api.tapsign.com.br/v1/webhooks/{webhookId}/logs/{logId}/retry

Headers

Header	Valor
Authorization	Bearer {token}

Exemplo de requisicao

curl -X POST "https://api.tapsign.com.br/v1/webhooks/wh_abc123def456/logs/log_001/retry" \
  -H "Authorization: Bearer {token}"

Resposta

Status: 200 OK

{
  "id": "log_003",
  "webhookId": "wh_abc123def456",
  "eventId": "evt_sgn_signed_001",
  "eventType": "signer.signed",
  "status": "PENDING",
  "attemptNumber": 4,
  "sentAt": "2026-03-29T17:00:00Z"
}

Reenvio manual

O reenvio manual nao conta para o limite de retentativas automaticas. Voce pode reenviar quantas vezes precisar.

---

Estatisticas de entrega

Retorna um resumo das entregas do webhook.

Requisicao

GET /v1/webhooks/{webhookId}/logs/stats

URL completa: https://api.tapsign.com.br/v1/webhooks/{webhookId}/logs/stats

Headers

Header	Valor
Authorization	Bearer {token}

Exemplo de requisicao

curl -X GET "https://api.tapsign.com.br/v1/webhooks/wh_abc123def456/logs/stats" \
  -H "Authorization: Bearer {token}"

Resposta

Status: 200 OK

{
  "webhookId": "wh_abc123def456",
  "totalDeliveries": 1520,
  "successful": 1487,
  "failed": 28,
  "pending": 5,
  "successRate": 97.83,
  "averageResponseTime": 210,
  "lastDeliveryAt": "2026-03-29T16:00:05Z",
  "period": {
    "from": "2026-03-01T00:00:00Z",
    "to": "2026-03-29T23:59:59Z"
  }
}

Campo	Tipo	Descricao
totalDeliveries	integer	Total de entregas no periodo
successful	integer	Entregas com sucesso
failed	integer	Entregas com falha
pending	integer	Entregas pendentes (aguardando retentativa)
successRate	number	Taxa de sucesso em percentual
averageResponseTime	integer	Tempo medio de resposta (ms)
lastDeliveryAt	string	Data da ultima entrega
period	object	Periodo dos dados (ultimos 30 dias)

Monitoramento

Acompanhe regularmente a taxa de sucesso dos seus webhooks. Se o successRate cair abaixo de 90%, verifique se seu servidor esta respondendo corretamente e dentro do timeout de 30 segundos.