Webhooks

Webhook endpointを削除

DELETE/api/v1alpha1/webhooks/{webhook_id}

Webhook endpointを削除し、そのendpointへの配信をすべて停止します。

アクセス: alphaを有効にしたAPI keyとMANAGE_WEBHOOKS権限。
応答: bodyはありません。
再試行: Idempotency-KeyはPOSTのみが対象のため、DELETEの再送は重複排除されません。
見つからない場合: 他のワークスペースのendpointは、存在しない場合と意図的に区別できません。

endpointを削除すると、その配信履歴はこのAPIから読み取れなくなります。監査に必要な記録は削除前に取得してください。

認証

apiKey

認証Bearer <token>

場所: header

パスパラメーター

webhook_id*string

登録済みWebhook endpointの識別子です。

レスポンスボディ

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

curl -X DELETE "https://example.com/api/v1alpha1/webhooks/wh_0190b5d4-7e1f-7a2b-9c3d-1234567890ab" \  -H "Authorization: Bearer $DEEPFRAME_API_KEY"

なし

Webhook endpointを更新 PATCH

Webhook endpointのURL、受信するevent、説明、有効・無効を変更します。

Webhook deliveryを一覧表示 GET

1つのendpointに対する配信の試行を、新しい順に返します。endpointがeventを受け取れなくなったときは、ここを確認します。