> ## Documentation Index > Fetch the complete documentation index at: https://docs.didit.me/llms.txt > Use this file to discover all available pages before exploring further. # Webhookの送信先更新API > DiditのWebhookの送信先を編集するAPI。ラベル、URL、有効状態、バージョン、購読するWebhookイベントを変更できます。Webhookをプログラムで管理でき、呼び出し単位の課金で契約は不要です。 Webhook送信先更新APIのプロンプト プロンプトをクリップボードにコピー \

\`Update a Didit webhook destination through the Management API.

Endpoint:
PATCH https://verification.didit.me/v3/webhook/destinations/{destination_uuid}/

Authentication:
Use the x-api-key header with my Didit API key.

Goal:
\- Change a destination's label, url, enabled state, webhook_version, or subscribed_events. Send only the fields you want to change.

Path parameter:
\- destination_uuid — the destination UUID from GET /v3/webhook/destinations/.

Request body (application/json) — all fields optional:
\{
"label": "Updated label",
"url": "https://yourapp.com/webhooks/v2",
"enabled": false,
"webhook_version": "v3",
"subscribed_events": ["status.updated", "data.updated", "transaction.created"]
}

Critical semantics:
\- subscribed_events is replaced wholesale, NOT merged. To add an event, GET the current destination, append to the list, and send the full array back. Sending [] returns 400.
\- url must remain unique among the application's destinations.
\- A uuid in the body is ignored: the path names the destination.
\- webhook_version applies to future deliveries only. Already-queued deliveries use the version that was active when they were enqueued.
\- The signing secret (secret_shared_key) is NOT rotated by PATCH. Console offers a manual rotation flow. For 24 hours after a rotation, every delivery also carries X-Signature-Previous, X-Signature-V2-Previous and X-Signature-Simple-Previous, made with the replaced secret, and previous_secret_expires_at says when that ends.
\- Changing url does not move automatic retries of deliveries already made: they go to the URL the first attempt used. A manual resend goes to the destination's current URL.

Example call (replace subscription list):
curl -X PATCH "https://verification.didit.me/v3/webhook/destinations/{destination_uuid}/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"subscribed_events": ["status.updated", "data.updated", "transaction.created"]}'

\# Pause a destination without losing config:
curl -X PATCH "https://verification.didit.me/v3/webhook/destinations/{destination_uuid}/" \
-H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"enabled": false}'

Failure modes:
\- 400 — empty subscribed_events, unknown event name, duplicate url among destinations, or invalid webhook_version.
\- 401 — missing or malformed x-api-key.
\- 403 — canonical { "detail": "You do not have permission to perform this action." } envelope.
\- 404 — destination not found in this application.

Side effects:
\- Subsequent webhook deliveries respect the new url, enabled flag, and subscribed_events list.

For the full integration shape, see /integration/integration-prompt.`

\
貼り付け先 このエンドポイントを使用して、Webhookの送信先と受信するイベントを変更できます。## `subscribed_events`の更新`subscribed_events`を送信する場合は、更新後も購読を継続するイベントの完全なリストを指定してください。この配列は、以前の購読イベントのセットを置き換えます。```json theme={null} { "subscribed_events": [ "status.updated", "data.updated", "transaction.created", "transaction.status.updated" ] } ```指定できる値は次のとおりです。| イベント | 内容 | | - | - | | `status.updated` | ユーザー認証 (KYC) または法人確認 (KYB) のセッションのステータスが変更されました。 | | `data.updated` | セッションの検証データが作成後に変更されました。 | | `user.status.updated` | ユーザーエンティティのステータスが変更されました。 | | `user.data.updated` | ユーザーエンティティのデータが変更されました。 | | `business.status.updated` | 企業エンティティのステータスが変更されました。 | | `business.data.updated` | 企業エンティティのデータが変更されました。 | | `activity.created` | 指定は受け付けられますが、現時点では本番トラフィックには配信されません。 | | `transaction.created` | 取引が作成され、初回の評価が行われました。 | | `transaction.status.updated` | 取引のステータスが変更されました。 | | `travel_rule.status.updated` | トラベルルールのやり取りのステータスが変更されました。 | | `workflow.compliance_changed` | 公開済みワークフローのコンプライアンスステータスが変更されました。 | | `transaction_rule_suggestions.created` | ルール提案の実行により、新しいルール変更が提案されました。 |Investigator(`investigator.*`)およびAuthentication(`auth.*`)のイベントファミリーも指定できます。完全なリストは[Webhook](https://docs.didit.me/ja/integration/webhooks.md#イベントタイプ)を参照してください。各イベントの詳しい説明とよく使われる購読イベントの組み合わせについては、[送信先作成ガイド](https://docs.didit.me/ja/management-api/webhook/create-destination.md)を参照してください。 ## OpenAPI ````yaml ja/openapi-25.json PATCH /v3/webhook/destinations/{destination_uuid}/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: 本人確認API。x-api-keyヘッダーで認証します。 servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/webhook/destinations/{destination_uuid}/: patch: tags: - Webhook summary: Webhookの送信先を更新 description: >- Webhookの送信先を更新します。**`subscribed_events`はマージされず、全体が置き換えられます**。先に取得し、追加してから再送信してください。シークレットはローテーションされません。ボディ内の`uuid`は無視され、送信先はパスで指定されます。 operationId: update_webhook_destination parameters: - name: destination_uuid in: path required: true description: 更新する送信先のUUIDです。 schema: type: string format: uuid example: 11111111-2222-3333-4444-555555555555 requestBody: required: true content: application/json: schema: type: object properties: label: type: string description: 人が読める新しい名前。 url: type: string format: uri description: 新しい送信先URL。アプリケーション内で一意である必要があります。 enabled: type: boolean description: この送信先を削除せずに配信を一時停止するには`false`に設定します。 webhook_version: type: string enum: - v1 - v2 - v3 description: 今後の配信に使用する新しいペイロードスキーマバージョン。 subscribed_events: $ref: '#/components/schemas/WebhookSubscribedEvents' examples: Pause destination: value: enabled: false Add transaction events: value: subscribed_events: - status.updated - data.updated - transaction.created - transaction.status.updated Move target URL: value: label: Production session webhooks v2 url: https://api.yourapp.com/webhooks/didit/v2 responses: '200': description: >- 更新後のWebhookの送信先。ボディは`GET /v3/webhook/destinations/{destination_uuid}/`と同じ形式です。 content: application/json: schema: type: object properties: uuid: type: string format: uuid label: type: string url: type: string format: uri enabled: type: boolean webhook_version: type: string enum: - v1 - v2 - v3 secret_shared_key: type: string secret_last4: type: string description: >- 送信先の現在の署名シークレットの末尾4文字。シークレットを区別するために使用します。署名の検証にはこれだけでは不十分です。 previous_secret_expires_at: type: string format: date-time nullable: true description: >- Business Consoleで送信先の署名シークレットをローテーションしてから24時間、設定されます。この時刻までは、送信先へのすべての配信に、置き換えられたシークレットで作成された`X-Signature-Previous`、`X-Signature-V2-Previous`、`X-Signature-Simple-Previous`も付与されます（[署名検証](/ja/integration/webhooks#署名検証)を参照）。過去24時間にローテーションが行われていない場合は`null`です。 subscribed_events: $ref: '#/components/schemas/WebhookSubscribedEvents' created_by_email: type: string nullable: true description: >- 送信先を作成したBusiness Consoleメンバーのメールアドレス。APIキーで作成された送信先の場合は`null`。 created_by_name: type: string nullable: true description: >- 送信先を作成したBusiness Consoleメンバーの名前。APIキーで作成された送信先の場合は`null`です。 created_at: type: string format: date-time updated_at: type: string format: date-time health_status: type: string enum: - healthy - degraded - failing description: >- 配信の健全性。`failing`: 送信先が最後に正常に応答して以降、3件以上の連続したイベントで最初の配信試行が失敗した状態です（`failing_streak`を参照）。`degraded`: failingではないものの、過去24時間以内に配信試行が失敗し、そのイベントがその後の試行でまだ配信されていない状態です。再試行または再送信で配信されると、この状態は解消されます。`healthy`: どちらにも該当しない状態です。`enabled`とは独立しています。失敗した試行とは、HTTP 400以上で応答された試行、またはまったく応答がなかった試行です。 failing_streak: type: integer description: >- 過去30日以内に、送信先が最後に成功応答して以降、最初の配信試行に連続して失敗したイベントの数です。再試行はカウントされず、再試行や再送を含め、いずれかの試行が成功すると連続記録は途切れます。最後の成功以降に失敗したイベントがない場合は`0`です。 failing_since: type: string format: date-time nullable: true description: >- 現在の`failing_streak`における最初の失敗した試行が行われた日時。`failing_streak`が`0`の場合は`null`。 last_success_at: type: string format: date-time nullable: true description: >- 過去30日以内に、送信先が配信に対して400未満のHTTPステータスで最後に応答した日時。その期間内に該当する応答がない場合は`null`。 environment: type: string enum: - live - sandbox description: 送信先を所有するアプリケーションの環境。 summary: type: object description: >- 直近`metrics_window_days`（30）日間の配信メトリクス。`last_delivery_at`は、いつ行われたかにかかわらず最新の試行です。 properties: total_deliveries: type: integer failed_deliveries: type: integer error_rate_percentage: type: integer min_response_time_ms: type: integer nullable: true avg_response_time_ms: type: integer nullable: true max_response_time_ms: type: integer nullable: true last_delivery_at: type: string format: date-time nullable: true metrics_window_days: type: integer description: その他のサマリー指標が対象とする期間の長さ（日数）。常に`30`です。 examples: Paused: value: uuid: 11111111-2222-3333-4444-555555555555 label: Production session webhooks url: https://yourapp.com/webhooks/didit enabled: false webhook_version: v3 secret_shared_key: tno2NTeRC1ZK3sBOYlBJDyEzBVENl3pQ1AcZyAW0xnQ secret_last4: 0xnQ previous_secret_expires_at: null subscribed_events: - status.updated - data.updated created_by_email: null created_by_name: null created_at: '2026-01-04T08:00:00Z' updated_at: '2026-05-17T11:02:55Z' health_status: healthy failing_streak: 0 failing_since: null last_success_at: '2026-05-17T09:21:18Z' environment: live summary: total_deliveries: 12453 failed_deliveries: 14 error_rate_percentage: 0 min_response_time_ms: 41 avg_response_time_ms: 187 max_response_time_ms: 2103 last_delivery_at: '2026-05-17T09:21:18Z' metrics_window_days: 30 '400': description: バリデーションに失敗しました（URLの重複、空または不明なイベントリスト、不正な形式のボディ）。 content: application/json: examples: Duplicate URL: value: url: - >- This webhook destination already exists for the application. Empty events: value: subscribed_events: - At least one subscribed event is required. '403': description: >- APIキーがない、形式が不正、期限切れ、または別のアプリケーションにスコープされています。キーがない場合は`403`、誤ったキー、失効したキー、期限切れのキーの場合は`401`を返します。 content: application/json: examples: Forbidden: value: detail: You do not have permission to perform this action. '404': description: このUUIDの送信先は存在しません（または削除済みか、別のアプリケーションに属しています）。 content: application/json: examples: Not found: value: detail: Webhook destination not found. '429': description: レート制限を超過しました。間隔を空けてから再試行してください。 content: application/json: examples: Throttled: value: detail: Request was throttled. Expected available in 30 seconds. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: >- curl -X PATCH 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/' \ -H 'x-api-key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "subscribed_events": [ "status.updated", "data.updated", "transaction.created" ] }' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.webhooks.destinations.update( "11111111-2222-3333-4444-555555555555", enabled=False, ) print(result) - lang: javascript label: Node.js source: >- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); const result = await didit.webhooks.destinations.update("11111111-2222-3333-4444-555555555555", { enabled: false, }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Webhooks.Destinations.Update(ctx, \"11111111-2222-3333-4444-555555555555\", didit.WebhooksDestinationsUpdateParams{\n\tEnabled: didit.Bool(false),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: >- import me.didit.Didit; import me.didit.types.WebhooksDestinationsUpdateParams; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.webhooks().destinations().update("11111111-2222-3333-4444-555555555555", WebhooksDestinationsUpdateParams.builder() .enabled(false) .build()); System.out.println(result); - lang: php label: PHP source: >- webhooks->destinations->update('11111111-2222-3333-4444-555555555555', [ 'enabled' => false, ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.webhooks.destinations.update( "11111111-2222-3333-4444-555555555555", enabled: false ) puts result.to_h - lang: csharp label: .NET source: >- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); var result = await client.Webhooks.Destinations.UpdateAsync("11111111-2222-3333-4444-555555555555", new WebhooksDestinationsUpdateParams { Enabled = false, }); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: WebhookSubscribedEvents: type: array description: >- このWebhookの送信先のイベントフィルターです。Diditは、イベントタイプがこれらの値のいずれかに完全に一致するWebhookのみを配信します。ワイルドカードによるサブスクリプションはありません。送信する場合、リストには有効なイベントを1つ以上含める必要があります(明示的な`[]`は400で拒否されます)。リストが空の送信先(作成時にフィールドを省略した場合)は何も受信しません。更新時、リストはマージされず、常に全体が置き換えられます。 minItems: 1 uniqueItems: true items: $ref: '#/components/schemas/WebhookEvent' example: - status.updated - data.updated WebhookEvent: type: string description: >- サポートされているWebhookイベント名。`subscribed_events`ではこれらの文字列を正確に使用してください。サポートされていない値は拒否されます。 enum: - status.updated - data.updated - user.status.updated - user.data.updated - business.status.updated - business.data.updated - activity.created - transaction.created - transaction.status.updated - travel_rule.status.updated - workflow.compliance_changed - transaction_rule_suggestions.created - auth.signup - auth.login - auth.login_failed - auth.password_reset_requested - auth.password_reset_completed - auth.mfa_changed - auth.new_device - auth.account_locked - investigator.report.ready - investigator.decision.automated - investigator.decision.overridden - investigator.decision.contested - investigator.question.raised - investigator.automation.paused - investigator.rfi.answered - investigator.rfi.overdue - investigator.drift.detected - investigator.sla.breached - investigator.qa.failed - investigator.external.report.ready securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権（なし、読み取り、書き込み）、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.