Webhookを削除

DELETE /v1/webhooks/{id}

Webhookを即座に削除します。削除されると、エンドポイントはイベントの受信を停止します。

試してみる

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

認証が必要です

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

DANGER

Webhookの削除は即時かつ永続的です。エンドポイントは即座にイベントの受信を停止します。この操作は取り消すことができません -- 新しいWebhookを作成する必要があります。

リクエスト

ヘッダー

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

パスパラメータ

パラメータ	型	必須	説明
`id`	`string`	はい	削除するWebhookのID（例：`webhook-abc123def456`）。

コード例

curlTypeScriptPython

bash

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

typescript

const apiKey = process.env.DOCMAP_API_KEY
const webhookId = 'webhook-abc123def456'

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

const result = await response.json()
console.log(result) // { success: true }

python

import requests

api_key = "dm_live_abc123def456ghi789jkl012mno345"
webhook_id = "webhook-abc123def456"

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

print(response.json())  # {"success": True}

レスポンス

ステータス: 200 OK

例

json

{
  "success": true
}

エラー

ステータス	コード	説明
`401`	`UNAUTHORIZED`	APIキー/トークンが欠落、無効、または期限切れです。
`403`	`FORBIDDEN`	このWebhookは別のユーザーに属しています。自分のWebhookのみ削除できます。
`404`	`NOT_FOUND`	指定されたIDのWebhookが見つかりません。

Webhookを削除 ​

リクエスト ​

ヘッダー ​

パスパラメータ ​

コード例 ​

レスポンス ​

例 ​

エラー ​