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"
]
}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.webhooks.destinations.update(
"11111111-2222-3333-4444-555555555555",
enabled=False,
)
print(result)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);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Webhooks.Destinations.Update(ctx, "11111111-2222-3333-4444-555555555555", didit.WebhooksDestinationsUpdateParams{
Enabled: didit.Bool(false),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)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);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->webhooks->destinations->update('11111111-2222-3333-4444-555555555555', [
'enabled' => false,
]);
print_r($result->toArray());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_husing 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));{
"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
}
}Webhookの送信先更新API
DiditのWebhookの送信先を編集するAPI。ラベル、URL、有効状態、バージョン、購読するWebhookイベントを変更できます。Webhookをプログラムで管理でき、呼び出し単位の課金で契約は不要です。
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"
]
}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.webhooks.destinations.update(
"11111111-2222-3333-4444-555555555555",
enabled=False,
)
print(result)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);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Webhooks.Destinations.Update(ctx, "11111111-2222-3333-4444-555555555555", didit.WebhooksDestinationsUpdateParams{
Enabled: didit.Bool(false),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)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);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->webhooks->destinations->update('11111111-2222-3333-4444-555555555555', [
'enabled' => false,
]);
print_r($result->toArray());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_husing 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));{
"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
}
}subscribed_eventsの更新
subscribed_eventsを送信する場合は、更新後も購読を継続するイベントの完全なリストを指定してください。この配列は、以前の購読イベントのセットを置き換えます。
{
"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.*)およびAuthentication(auth.*)のイベントファミリーも指定できます。完全なリストはWebhookを参照してください。
各イベントの詳しい説明とよく使われる購読イベントの組み合わせについては、送信先作成ガイドを参照してください。承認
お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権(なし、読み取り、書き込み)、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys
パスパラメータ
更新する送信先のUUIDです。
ボディ
人が読める新しい名前。
新しい送信先URL。アプリケーション内で一意である必要があります。
この送信先を削除せずに配信を一時停止するにはfalseに設定します。
今後の配信に使用する新しいペイロードスキーマバージョン。
v1, v2, v3 このWebhookの送信先のイベントフィルターです。Diditは、イベントタイプがこれらの値のいずれかに完全に一致するWebhookのみを配信します。ワイルドカードによるサブスクリプションはありません。送信する場合、リストには有効なイベントを1つ以上含める必要があります(明示的な[]は400で拒否されます)。リストが空の送信先(作成時にフィールドを省略した場合)は何も受信しません。更新時、リストはマージされず、常に全体が置き換えられます。
1サポートされているWebhookイベント名。subscribed_eventsではこれらの文字列を正確に使用してください。サポートされていない値は拒否されます。
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 ["status.updated", "data.updated"]
レスポンス
更新後のWebhookの送信先。ボディはGET /v3/webhook/destinations/{destination_uuid}/と同じ形式です。
v1, v2, v3 送信先の現在の署名シークレットの末尾4文字。シークレットを区別するために使用します。署名の検証にはこれだけでは不十分です。
このWebhookの送信先のイベントフィルターです。Diditは、イベントタイプがこれらの値のいずれかに完全に一致するWebhookのみを配信します。ワイルドカードによるサブスクリプションはありません。送信する場合、リストには有効なイベントを1つ以上含める必要があります(明示的な[]は400で拒否されます)。リストが空の送信先(作成時にフィールドを省略した場合)は何も受信しません。更新時、リストはマージされず、常に全体が置き換えられます。
1サポートされているWebhookイベント名。subscribed_eventsではこれらの文字列を正確に使用してください。サポートされていない値は拒否されます。
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 ["status.updated", "data.updated"]
送信先を作成したBusiness Consoleメンバーのメールアドレス。APIキーで作成された送信先の場合はnull。
送信先を作成したBusiness Consoleメンバーの名前。APIキーで作成された送信先の場合はnullです。
配信の健全性。failing: 送信先が最後に正常に応答して以降、3件以上の連続したイベントで最初の配信試行が失敗した状態です(failing_streakを参照)。degraded: failingではないものの、過去24時間以内に配信試行が失敗し、そのイベントがその後の試行でまだ配信されていない状態です。再試行または再送信で配信されると、この状態は解消されます。healthy: どちらにも該当しない状態です。enabledとは独立しています。失敗した試行とは、HTTP 400以上で応答された試行、またはまったく応答がなかった試行です。
healthy, degraded, failing 過去30日以内に、送信先が最後に成功応答して以降、最初の配信試行に連続して失敗したイベントの数です。再試行はカウントされず、再試行や再送を含め、いずれかの試行が成功すると連続記録は途切れます。最後の成功以降に失敗したイベントがない場合は0です。
現在のfailing_streakにおける最初の失敗した試行が行われた日時。failing_streakが0の場合はnull。
過去30日以内に、送信先が配信に対して400未満のHTTPステータスで最後に応答した日時。その期間内に該当する応答がない場合はnull。
送信先を所有するアプリケーションの環境。
live, sandbox 直近metrics_window_days(30)日間の配信メトリクス。last_delivery_atは、いつ行われたかにかかわらず最新の試行です。
Show child attributes
Show child attributes