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

Webhook で配達の最新情報を受け取る

API: Drive

このドキュメントでは、Drive API について説明しています。Drive(クラシック)API を使用している場合は、「Drive(クラシック)の Webhook ハウツーガイド」をご覧ください。

Webhook を使用すると、DoorDash やダッシャーからのほぼリアルタイムの情報フローをアプリケーションおよびお客様に流すことができます。Webhook を使用すれば、ダッシャーが配達先住所までどのくらいの距離にいるかを地図でお客様に表示したり、注文の最新ステータスをプッシュ通知でお客様に伝えたりするなど、リアルタイムの情報提供が可能になります。

Webhook を設定するには、Webhook を送信する HTTP/HTTPS エンドポイントがアプリから提供される必要があります。アプリのエンドポイントが認証されている場合は、「Authorization」ヘッダーの正しい値も提供する必要があります。

Webhook の URL と認証ヘッダーの設定

開発者ポータルを使用して、アプリの Webhook エンドポイントおよび関連する認証ヘッダーを設定します。プラスアイコンをクリックして、Sandbox またはプロダクション環境の Webhook エンドポイントを設定します。各環境でサポートされるエンドポイントは 1 つだけです。

注意: プロダクション Webhook エンドポイントを設定するには、まずプロダクションアクセスをリクエストする必要があります。

Webhookページのスクリーンショット

表示されたダイアログで、アプリのコールバック URL を入力します。また、必要であれば、DoorDash が各 Webhook で送信する「Authorization」ヘッダーの内容も入力します。

Webhookエンドポイント設定ダイアログのスクリーンショット

Webhook イベントを受信する準備

DoorDash 開発者は、以下のイベントが発生すると直ちにそのイベントの Webhook を送信します。

  • DASHER_CONFIRMED: ダッシャーが配達を受け付け、受け取り場所に向かって移動中です。
  • DASHER_CONFIRMED_PICKUP_ARRIVAL: ダッシャーが受け取り場所に到着しました。
  • DASHER_PICKED_UP: ダッシャーが配達する商品を受け取りました。
  • DASHER_CONFIRMED_DROPOFF_ARRIVAL: ダッシャーが配達先住所に到着しました。
  • DASHER_DROPPED_OFF: ダッシャーが配達先住所に商品を配達しました。配達は完了です。
  • DELIVERY_CANCELLED: 配達がキャンセルされました。