Список вебхуков

GET /v1/webhooks

Список всех активных вебхуков для аутентифицированного пользователя. Ответ никогда не содержит секретов подписи -- только метаданные для идентификации и управления.

Попробуйте

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

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

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

Запрос

Заголовки

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

Этот эндпоинт не принимает параметров запроса или тела запроса.

Примеры кода

curl

curl https://api.docmap.io/v1/webhooks \
  -H "Authorization: Bearer dm_live_abc123def456ghi789jkl012mno345"

TypeScript

const apiKey = process.env.DOCMAP_API_KEY

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

const { data } = await response.json()

for (const webhook of data) {
  console.log(`${webhook.url} — events: ${webhook.events.join(', ')}`)
}

Python

import requests

api_key = "dm_live_abc123def456ghi789jkl012mno345"

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

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

for webhook in webhooks:
    events = ", ".join(webhook["events"])
    print(f"{webhook['url']} — events: {events}")

Ответ

Статус: 200 OK

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

Поля

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

Поле	Тип	Описание
id	string	Уникальный идентификатор вебхука.
userId	string	ID пользователя, которому принадлежит вебхук.
url	string	Зарегистрированный URL эндпоинта.
events	string[]	События, на которые подписан вебхук.
active	boolean	Активен ли вебхук. В этом ответе всегда true.
createdAt	string	Временная метка ISO 8601 создания вебхука.

Пример

{
  "data": [
    {
      "id": "webhook-abc123def456",
      "userId": "uid_a1b2c3d4e5f6",
      "url": "https://your-app.com/webhooks/docmap",
      "events": ["extraction.completed", "extraction.failed"],
      "active": true,
      "createdAt": "2025-01-15T10:00:00.000Z"
    },
    {
      "id": "webhook-xyz789uvw012",
      "userId": "uid_a1b2c3d4e5f6",
      "url": "https://slack-webhook.example.com/docmap",
      "events": ["extraction.failed"],
      "active": true,
      "createdAt": "2025-01-10T08:00:00.000Z"
    }
  ]
}

Ошибки

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