メインコンテンツへスキップ
GET
curl

送信先の稼働状況

health_statusは、送信先が配信にどのように応答してきたかを要約したものです。 失敗した試行とは、送信先がHTTP 400以上で応答したか、まったく応答しなかった(タイムアウト、接続拒否、またはブロックされたアドレス)試行を指します。 再試行はfailing_streakに加算されず、再試行や再送信を含め、成功した試行が1件でもあれば連続失敗は終了します。 health_statusはenabledとは独立しています。 配信メトリクスとdaily_pointsは過去30日間(metrics_window_days)を対象とします。 daily_pointsには常に30件のエントリがあり、UTCの1日ごとに1件、古い順に並びます。

関連ページ

承認

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

レスポンス

Webhookの送信先のリスト(ページネーションなし、古い順)。

uuid
string<uuid>

不変の送信先識別子。更新・削除の際に{destination_uuid}として使用します。

label
string

Consoleに表示される、人が読める名前。

url
string<uri>

Webhookペイロードを含むPOSTリクエストを受信する送信先URL。

enabled
boolean

falseの場合、Diditはこの送信先への配信を通知なしでスキップします。

webhook_version
enum<string>

この送信先に送信されるペイロードのスキーマバージョン。v3が現在の推奨形式です。

利用可能なオプション:
v1,
v2,
v3
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
例:
subscribed_events_count
integer

subscribed_eventsの長さをキャッシュした値。UIの表示に便利です。

deliveries_count
integer

過去30日間にこの送信先に対して行われた配信試行(再試行を含む)の回数。

failed_deliveries_count
integer

過去30日間の配信試行のうち、送信先がHTTP 400以上で応答したもの、または応答しなかったもの(タイムアウト、接続拒否、ブロックされたアドレス)の回数。

average_response_time_ms
integer | null

過去30日間の平均応答時間(ミリ秒、整数に丸めた値)。この期間に配信がなかった場合はnull。

error_rate_percentage
integer

過去30日間のround(failed_deliveries_count / deliveries_count * 100)です。配信がない場合は0です。

last_delivery_at
string<date-time> | null

直近の配信試行(成功または失敗)の日時。一度も配信されていない場合はnullです。

metrics_window_days
integer

deliveries_count、failed_deliveries_count、average_response_time_ms、error_rate_percentage、daily_pointsが対象とする期間の長さ(日数)。常に30です。

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
daily_points
object[]

過去30日間のUTC日ごとに1エントリーで、古い順に並び、配信のない日も含みます。再試行を含むすべての試行をカウントします。

secret_last4
string

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

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>
最終更新日 2026年11月1日