Список доставок

GET /v1/webhooks/deliveries

Список последних попыток доставки вебхуков для аутентифицированного пользователя. Возвращает журналы доставки, упорядоченные по убыванию даты, чтобы вы могли отслеживать, успешно ли ваши вебхуки получают события.

Попробуйте

Протестируйте этот эндпоинт интерактивно в Swagger UI.

Требуется авторизация

Укажите ваш API-ключ в заголовке Authorization.

Запрос

Заголовки

Заголовок	Значение	Обязательно
Authorization	Bearer <token>	Да

Параметры запроса

Параметр	Тип	По умолчанию	Описание
webhookId	string	—	Фильтрация доставок по определенному ID вебхука.
limit	number	50	Максимальное количество возвращаемых результатов (1–100).

Примеры кода

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)")

Ответ

Статус: 200 OK

Тело ответа содержит массив data с объектами журнала доставки.

Поля

Каждый объект в массиве содержит:

Поле	Тип	Описание
id	string	Уникальный идентификатор записи доставки.
userId	string	ID пользователя, которому принадлежит вебхук.
webhookId	string	ID целевого вебхука.
extractionId	string	ID извлечения, вызвавшего эту доставку.
event	string	Название события: extraction.completed или extraction.failed.
url	string	URL вебхука на момент доставки.
status	string	success, если эндпоинт вернул статус 2xx, failed в противном случае.
httpStatus	number | null	HTTP-статус ответа. null, если запрос не получил ответа (например, сетевая ошибка, тайм-аут).
error	string | null	Сообщение об ошибке при неудачной доставке. null при успехе.
durationMs	number	Время обращения к эндпоинту в миллисекундах.
createdAt	string	Временная метка ISO 8601 попытки доставки.

Пример

{
  "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"
    }
  ]
}

Ошибки

Статус	Код	Описание
401	UNAUTHORIZED	Отсутствующий, недействительный или просроченный API-ключ / токен.