Webhookイベントガイド

Dodo Paymentsは、トランザクション、サブスクリプション、返金、紛争、ライセンスキー管理に関連する重要なイベントについてリアルタイムのWebhook通知を提供します。以下は、これらのイベントの詳細ガイドであり、明確さのためにカテゴリ分けされており、実装のヒントと考慮事項が含まれています。

支払いイベント

Event Name	Event Type	Description
Payment Succeeded	`payment.succeeded`	支払いが正常に処理されたときにトリガーされます。
Payment Failed	`payment.failed`	エラー、カードの拒否、その他の理由で支払い試行が失敗したときに発生します。
Payment Processing	`payment.processing`	支払いが現在処理されていることを示します。
Payment Cancelled	`payment.cancelled`	支払いが完了する前にキャンセルされたときにトリガーされます。

返金イベント

Event Name	Event Type	Description
Refund Succeeded	`refund.succeeded`	払い戻しが正常に処理されたときにトリガーされます。
Refund Failed	`refund.failed`	処理エラーやその他の理由で払い戻し試行が失敗したときに発生します。

紛争イベント

Event Name	Event Type	Description
Dispute Opened	`dispute.opened`	顧客が異議を申し立てたときにトリガーされます。
Dispute Expired	`dispute.expired`	解決されないまま異議の期限が切れたことを示します。
Dispute Accepted	`dispute.accepted`	出品者が異議を受け入れたときにトリガーされます。
Dispute Cancelled	`dispute.cancelled`	顧客またはシステムによって異議がキャンセルされたときに発生します。
Dispute Challenged	`dispute.challenged`	出品者が異議に異議を唱えたときにトリガーされます。
Dispute Won	`dispute.won`	出品者が異議を勝利したことを示します。
Dispute Lost	`dispute.lost`	出品者が異議に敗北したときに発生します。

サブスクリプションイベント

イベント名	イベントタイプ	説明
サブスクリプション有効化	`subscription.active`	サブスクリプションが有効になり、継続的な請求が予定されていることを示します。
サブスクリプション更新	`subscription.updated`	サブスクリプションのいずれかのフィールドが更新されたときにトリガーされます（ポーリングなしのリアルタイム同期）。
サブスクリプション保留	`subscription.on_hold`	更新に失敗したため、サブスクリプションが一時的に保留されたときにトリガーされます。
サブスクリプション一時停止	`subscription.paused`	サブスクリプションが一時停止されたときにトリガーされます。
サブスクリプション一時停止解除	`subscription.unpaused`	一時停止されていたサブスクリプションが再開されたときにトリガーされます。
サブスクリプション更新完了	`subscription.renewed`	サブスクリプションの更新が正常に完了したときに発生します。
サブスクリプションプラン変更	`subscription.plan_changed`	サブスクリプションがアップグレード、ダウングレード、または異なるアドオンで変更されたときにトリガーされます。
サブスクリプションの支払い方法更新	`subscription.update_payment_method`	サブスクリプションの支払い方法が更新されたときに送信されます。Subscription payload が含まれます。
サブスクリプションキャンセル	`subscription.cancelled`	Merchant または customer によってサブスクリプションがキャンセルされたときにトリガーされます。
サブスクリプション失敗	`subscription.failed`	サブスクリプションが失敗したことを示します。これは、mandate を作成できなかったことを意味します。
サブスクリプション期限切れ	`subscription.expired`	サブスクリプションが契約期間の終了に達して期限切れになったときにトリガーされます。

ライセンスキーイベント

Event Name	Event Type	Description
License Key Created	`license_key.created`	製品の新しいライセンスキーが作成されたときにトリガーされます。

資格付与イベント

イベント名	イベントタイプ	説明
Grant Created	`entitlement_grant.created`	顧客のために新しい資格付与が作成されます。ライセンスキーの付与は`delivered`に到着します；OAuthを基にした付与（Discord、GitHub、Notion）は`pending`に到着します。
Grant Delivered	`entitlement_grant.delivered`	付与の履行が完了します — ライセンスキーが発行され、ファイルリンクが解決されるか、プラットフォームアクセスが与えられます。
Grant Failed	`entitlement_grant.failed`	付与の履行が失敗しました；`error_code`と`error_message`を調査します。
Grant Revoked	`entitlement_grant.revoked`	アクセスが撤回されました；`revocation_reason`（サブスクリプションの状態、返金、プラン変更、または手動）を調査します。

詳細なペイロードスキーマ、サンプルイベント、および完全なrevocation_reasonリファレンスについては、資格付与Webhookを参照してください。

クレジットイベント

イベント名	イベントタイプ	説明
Credit Added	`credit.added`	クレジットが顧客に付与されたときにトリガーされます（サブスクリプション、一度きり、アドオン、またはAPI）。
Credit Deducted	`credit.deducted`	使用または手動のデビットを通じてクレジットが消費されると発生します。
Credit Expired	`credit.expired`	設定された有効期限期間の後に未使用のクレジットが失効したときにトリガーされます。
Credit Rolled Over	`credit.rolled_over`	未使用のクレジットがサイクルの終わりに新しい付与に繰り越されたときに発生します。
Rollover Forfeited	`credit.rollover_forfeited`	最大繰り越し回数に達したためにクレジットが没収されたときにトリガーされます。
Overage Charged	`credit.overage_charged`	ゼロバランスを超えて使用されたために超過料金が適用されたときに発生します。
Manual Adjustment	`credit.manual_adjustment`	手動でクレジットまたはデビットの調整が行われたときにトリガーされます。
Balance Low	`credit.balance_low`	クレジット残高が設定された閾値を下回ったときにトリガーされます。

回復イベント

イベント名	イベントタイプ	説明
Abandoned Checkout Detected	`abandoned_checkout.detected`	不完全または失敗したチェックアウトが60分後に検出されたときにトリガーされます。
Abandoned Checkout Recovered	`abandoned_checkout.recovered`	顧客が回復リンクを通じて支払いを完了したときに発生します。

詳細なペイロードスキーマ、フィールドの説明、およびハンドラーの例については、復旧用Webhookを参照してください。

ダニングイベント

イベント名	イベントタイプ	説明
Dunning Started	`dunning.started`	保留またはキャンセルされたサブスクリプションに対してダニング試行が開始されるとトリガーされます。
Dunning Recovered	`dunning.recovered`	顧客が支払い方法を更新して結果的に課金が成功したときに発生します。

詳細なペイロードスキーマ、フィールド説明、およびハンドラーの例については、回復Webhookを参照してください。

Payout Events

これらのイベントは、ダッシュボードに表示されるpayout statusesを反映しながら、Dodo Paymentsから銀行口座への資金の移動を追跡します。payloadは、GET /payoutsのエントリと同じ構造のpayout objectです。

イベント名	イベントタイプ	説明
Payout作成	`payout.created`	自動payout cycleまたは通常サイクル外の処理によって、payoutが作成されたときにトリガーされます。
Payout処理中	`payout.in_progress`	payoutの支払期日が到来し、payoutの処理が開始されたときに発生します。
Payout保留	`payout.on_hold`	payoutが一時停止された、または審査対象になったときにトリガーされます。
Payout成功	`payout.success`	銀行口座へのpayoutが正常に処理されたときに発生します。
Payout失敗	`payout.failed`	payoutが失敗したときにトリガーされます。資金と手数料はwalletに返金されます。

Payout Eventsが終了状態または厳密に順序付けられていると想定しないでください。銀行が送金を返却した場合、payout.failedがpayout.successの後に正当に到着することがあります。また、失敗したpayoutが後から復旧された場合は、payout.successがpayout.failedの後に到着することがあります。常にpayload上のstatusを現在の状態として扱ってください。

payout.createdは、以前はpayout.not_initiatedとして発行されていました。payout.not_initiatedでfilterしている既存のendpointがある場合は、引き続き一致するようにfilterをpayout.createdへ更新してください。

詳細なpayload schema、フィールドの説明、handlerの例については、Payout Webhooksを参照してください。これらのwebhook eventsは、Merchantが業務を効果的に管理するために重要な更新情報を提供するよう設計されています。webhook integrationで関連する各イベントに対する堅牢なhandlerを実装し、スムーズで信頼性の高い機能を確保してください。

Getting Started

Features

Integrate

Merchant of Record

Miscellaneous

支払いイベント

返金イベント

紛争イベント

サブスクリプションイベント

ライセンスキーイベント

資格付与イベント

クレジットイベント

回復イベント

ダニングイベント

Payout Events

​支払いイベント

​返金イベント

​紛争イベント

​サブスクリプションイベント

​ライセンスキーイベント

​資格付与イベント

​クレジットイベント

​回復イベント

​ダニングイベント

​Payout Events

支払いイベント

返金イベント

紛争イベント

サブスクリプションイベント

ライセンスキーイベント

資格付与イベント

クレジットイベント

回復イベント

ダニングイベント

Payout Events