Listar entregas

GET /v1/webhooks/deliveries

Lista los intentos recientes de entrega de webhooks del usuario autenticado. Devuelve los registros de entrega ordenados del más reciente al más antiguo, para que puedas monitorear si tus webhooks están recibiendo eventos correctamente.

Pruébalo

Prueba este endpoint de forma interactiva en la Swagger UI.

Autorización requerida

Incluye tu clave API en el encabezado Authorization.

Solicitud

Encabezados

Encabezado	Valor	Requerido
Authorization	Bearer <token>	Sí

Parámetros de consulta

Parámetro	Tipo	Predeterminado	Descripción
webhookId	string	—	Filtrar entregas por un ID de webhook específico.
limit	number	50	Número máximo de resultados a devolver (1--100).

Ejemplos de código

curl

curl "https://api.docmap.io/v1/webhooks/deliveries?limit=10" \
  -H "Authorization: Bearer dm_live_abc123def456ghi789jkl012mno345"

TypeScript

const apiKey = process.env.DOCMAP_API_KEY

const response = await fetch(
  'https://api.docmap.io/v1/webhooks/deliveries?limit=10',
  { headers: { 'Authorization': `Bearer ${apiKey}` } },
)

const { data } = await response.json()

for (const delivery of data) {
  console.log(`${delivery.event} → ${delivery.url} — ${delivery.status} (${delivery.durationMs}ms)`)
}

Python

import requests

api_key = "dm_live_abc123def456ghi789jkl012mno345"

response = requests.get(
    "https://api.docmap.io/v1/webhooks/deliveries",
    headers={"Authorization": f"Bearer {api_key}"},
    params={"limit": 10},
)

deliveries = response.json()["data"]

for d in deliveries:
    print(f"{d['event']} → {d['url']} — {d['status']} ({d['durationMs']}ms)")

Respuesta

Estado: 200 OK

El cuerpo de la respuesta contiene un array data de objetos de registro de entrega.

Campos

Cada objeto en el array contiene:

Campo	Tipo	Descripción
id	string	Identificador único del registro de entrega.
userId	string	ID del usuario propietario del webhook.
webhookId	string	ID del webhook al que se dirigió la entrega.
extractionId	string	ID de la extracción que desencadenó esta entrega.
event	string	Nombre del evento: extraction.completed o extraction.failed.
url	string	La URL del webhook en el momento de la entrega.
status	string	success si el endpoint devolvió un estado 2xx, failed en caso contrario.
httpStatus	number | null	Código de estado HTTP de la respuesta. null si la solicitud falló antes de recibir una respuesta (por ejemplo, error de red, timeout).
error	string | null	Mensaje de error si la entrega falló. null en caso de éxito.
durationMs	number	Tiempo de ida y vuelta del intento de entrega en milisegundos.
createdAt	string	Marca de tiempo ISO 8601 de cuándo se intentó la entrega.

Ejemplo

{
  "data": [
    {
      "id": "abc123def456",
      "userId": "uid_a1b2c3d4e5f6",
      "webhookId": "webhook-abc123def456",
      "extractionId": "extract-xyz789",
      "event": "extraction.completed",
      "url": "https://your-app.com/webhooks/docmap",
      "status": "success",
      "httpStatus": 200,
      "error": null,
      "durationMs": 342,
      "createdAt": "2025-01-20T14:30:04.000Z"
    },
    {
      "id": "def456ghi789",
      "userId": "uid_a1b2c3d4e5f6",
      "webhookId": "webhook-abc123def456",
      "extractionId": "extract-uvw456",
      "event": "extraction.failed",
      "url": "https://your-app.com/webhooks/docmap",
      "status": "failed",
      "httpStatus": null,
      "error": "The operation was aborted due to timeout",
      "durationMs": 10003,
      "createdAt": "2025-01-20T12:15:00.000Z"
    }
  ]
}

Errores

Estado	Código	Descripción
401	UNAUTHORIZED	Clave API / token faltante, inválido o expirado.