ウェブフックの種類
利用可能なすべてのウェブフックの種類はWebhookType列挙型に含まれています。各ウェブフックの例のペイロードはイベントタイプガイドで確認できます。
ウェブフックの作成
APIを介してウェブフックを作成するには：
GraphQL
1
2
3
4
5
6
7
8
9
10
11
12
13
14
mutation {
webhookCreate(
input: {
url: "https://example.com/webhooks/zonos"
type: ORDER_CREATED
status: ENABLED
}
) {
id
url
type
status
}
}
ウェブフックの詳細を編集する
APIを介して既存のウェブフックを編集するには：
GraphQL
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
mutation {
webhookUpdate(
input: {
id: "webhook-id"
url: "https://example.com/webhooks/zonos"
type: ORDER_CREATED
status: ENABLED
}
) {
id
url
type
status
}
}
ウェブフックログの表示
APIを介してウェブフックログを表示するには：
GraphQL
1
2
3
4
5
6
7
8
9
10
11
12
13
query {
webhookLogs(first: 20, after: "yyyyyyy", filter: { type: ORDER_CREATED }) {
edges {
node {
id
type
url
createdAt
responseStatus
}
}
}
}
ウェブフックでイベントをリッスンする
Zonos統合のリアルタイムイベント通知を受け取ります。
ウェブフックは、特定のイベントが発生したときにZonosが外部システムに積極的に通知する方法を提供します。購読したイベントが発生すると、Zonosは指定したウェブフックURLにHTTP POSTリクエストを送信します。リクエストボディにはイベントの詳細が含まれ、あなたのシステムがプログラム的にイベントを処理できるようになります。
ウェブフックは、Zonosを他のプラットフォームと統合したり、自動化されたワークフローをトリガーしたり、システム間でデータをリアルタイムで同期させたりするのに役立ちます。たとえば、ウェブフックを使用して次のことができます：