メインコンテンツへスキップ
GET
curl
レスポンスには、一覧と同じ稼働状況に関するフィールドに加えて、直近30日間のsummaryが含まれます。

関連ページ

  • Webhookの送信先一覧: すべての送信先と、その稼働状況および日ごとの配信件数。
  • Webhookガイド: シークレットのローテーション中を含む、署名の検証方法。

承認

x-api-key
string
header
必須

お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権(なし、読み取り、書き込み)、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys

パスパラメータ

destination_uuid
string<uuid>
必須

送信先のUUID (作成または一覧取得で返されるuuid) です。

レスポンス

Webhookの送信先の詳細。

uuid
string<uuid>
label
string
url
string<uri>
enabled
boolean
webhook_version
enum<string>
利用可能なオプション:
v1,
v2,
v3
secret_shared_key
string

HMAC署名シークレット(43文字のURLセーフなトークン)。APIキーで呼び出す場合は常に完全な値が返されます。Consoleユーザーにはread:webhooksが必要で、権限がない場合は空文字列になります。

secret_last4
string

送信先の現在の署名シークレットの末尾4文字。シークレットを区別するために使用します。署名の検証にはこれだけでは不十分です。

previous_secret_expires_at
string<date-time> | null

Business Consoleで送信先の署名シークレットをローテーションしてから24時間、設定されます。この時刻までは、送信先へのすべての配信に、置き換えられたシークレットで作成されたX-Signature-Previous、X-Signature-V2-Previous、X-Signature-Simple-Previousも付与されます(署名検証を参照)。過去24時間にローテーションが行われていない場合はnullです。

subscribed_events
enum<string>[]

このWebhookの送信先のイベントフィルターです。Diditは、イベントタイプがこれらの値のいずれかに完全に一致するWebhookのみを配信します。ワイルドカードによるサブスクリプションはありません。送信する場合、リストには有効なイベントを1つ以上含める必要があります(明示的な[]は400で拒否されます)。リストが空の送信先(作成時にフィールドを省略した場合)は何も受信しません。更新時、リストはマージされず、常に全体が置き換えられます。

Minimum array length: 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
例:
created_by_email
string | null

送信先を作成したBusiness Consoleメンバーのメールアドレス。APIキーで作成された送信先の場合はnull。

created_by_name
string | null

送信先を作成したBusiness Consoleメンバーの名前。APIキーで作成された送信先の場合はnullです。

created_at
string<date-time>
updated_at
string<date-time>
health_status
enum<string>

配信の健全性。failing: 送信先が最後に正常に応答して以降、3件以上の連続したイベントで最初の配信試行が失敗した状態です(failing_streakを参照)。degraded: failingではないものの、過去24時間以内に配信試行が失敗し、そのイベントがその後の試行でまだ配信されていない状態です。再試行または再送信で配信されると、この状態は解消されます。healthy: どちらにも該当しない状態です。enabledとは独立しています。失敗した試行とは、HTTP 400以上で応答された試行、またはまったく応答がなかった試行です。

利用可能なオプション:
healthy,
degraded,
failing
failing_streak
integer

過去30日以内に、送信先が最後に成功応答して以降、最初の配信試行に連続して失敗したイベントの数です。再試行はカウントされず、再試行や再送を含め、いずれかの試行が成功すると連続記録は途切れます。最後の成功以降に失敗したイベントがない場合は0です。

failing_since
string<date-time> | null

現在のfailing_streakにおける最初の失敗した試行が行われた日時。failing_streakが0の場合はnull。

last_success_at
string<date-time> | null

過去30日以内に、送信先が配信に対して400未満のHTTPステータスで最後に応答した日時。その期間内に該当する応答がない場合はnull。

environment
enum<string>

送信先を所有するアプリケーションの環境。

利用可能なオプション:
live,
sandbox
summary
object

直近metrics_window_days(30)日間の配信メトリクス。last_delivery_atは、いつ行われたかにかかわらず最新の試行です。

最終更新日 2026年11月1日