DOCS

Webhooks

Webhook を使用してイベントをリッスンする

Zonos 統合に関するリアルタイムのイベント通知を取得します。

Webhook は、特定のイベントが発生するたびに、Zonos が外部システムに事前に通知する方法を提供します。サブスクライブされたイベントが発生すると、Zonos は指定した Webhook URL に HTTP POST リクエストを送信します。リクエスト本文にはイベントの詳細が含まれるため、システムはイベントをプログラムで処理できるようになります。

Webhook は、Zonos を他のプラットフォームと統合し、自動化されたワークフローをトリガーし、システム間でリアルタイムでデータの同期を維持するのに役立ちます。たとえば、Webhook を使用して次のことができます。

  • Zonos で注文が作成されたときに、注文管理システムを更新します。
  • 出荷がキャンセルされた場合はフルフィルメントプロバイダーに通知します
  • 監査目的で国際注文のステータス変更をログに記録します

Webhook タイプ 

使用可能なすべての Webhook タイプは、XLOC0X 列挙型に含まれています。それぞれのペイロードの例は、Event Types ガイドにあります。

Webhook の作成 

API 経由で Webhook を作成するには:

1mutation WebhookCreate($input: WebhookCreateInput!) {
2 webhookCreate(input: $input) {
3 id
4 url
5 type
6 status
7 }
8}

Webhook の詳細を編集する 

API 経由で既存の Webhook を編集するには:

1mutation WebhookUpdate($input: WebhookUpdateInput!) {
2 webhookUpdate(input: $input) {
3 id
4 url
5 type
6 status
7 }
8}

Webhook ログを表示する 

API 経由で Webhook ログを表示するには:

1query WebhookLogs(
2$first: Int
3$after: String
4$filter: WebhookLogsFilterInput
5) {
6 webhookLogs(first: $first, after: $after, filter: $filter) {
7 edges {
8 node {
9 id
10 type
11 url
12 createdAt
13 responseStatus
14 }
15 }
16 }
17}
GraphQL API ReferenceTypes, inputs, and operations used in this guide

このページは役に立ちましたか?