Webhook一覧

GET /v1/webhooks

認証済みユーザーのすべてのアクティブなWebhookを一覧表示します。レスポンスには署名シークレットは含まれません -- 識別と管理のためのメタデータのみです。

試してみる

このエンドポイントを Swagger UI でインタラクティブにテストできます。

認証が必要です

Authorization ヘッダーにAPIキーを含めてください。

リクエスト

ヘッダー

ヘッダー	値	必須
`Authorization`	`Bearer <token>`	はい

このエンドポイントにはクエリパラメータやリクエストボディはありません。

コード例

curlTypeScriptPython

bash

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

レスポンスボディには、Webhookメタデータオブジェクトの data 配列が含まれています。

フィールド

配列内の各オブジェクトには以下が含まれます：

フィールド	型	説明
`id`	`string`	Webhookの一意の識別子。
`userId`	`string`	Webhookを所有するユーザーのID。
`url`	`string`	登録されたエンドポイントURL。
`events`	`string[]`	Webhookが購読しているイベント。
`active`	`boolean`	Webhookがアクティブかどうか。このレスポンスでは常に `true`。
`createdAt`	`string`	Webhookが作成されたISO 8601タイムスタンプ。

例

json

{
  "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キー/トークンが欠落、無効、または期限切れです。

Webhook一覧 ​

リクエスト ​

ヘッダー ​

コード例 ​

レスポンス ​

フィールド ​

例 ​

エラー ​