DOCS

Webhooks

Webhook으로 event 수신

Zonos 통합에 대한 real-time event notification을 받습니다.

Webhook은 특정 event 발생 시 Zonos가 external system에 proactive하게 알리는 방법입니다. subscribe한 event가 발생하면 Zonos가 지정한 webhook URL로 HTTP POST request를 보냅니다. request body에 event 상세가 포함되어 system이 programmatically 처리할 수 있습니다.

Webhook은 Zonos를 다른 platform과 통합하고, automated workflow를 trigger하며, system 간 data를 real-time으로 sync하는 데 유용합니다. 예:

  • Zonos에서 order가 생성되면 order management system을 업데이트
  • shipment이 canceled되면 fulfillment provider에 알림
  • auditing을 위해 international order status change를 log

Webhook type 

사용 가능한 모든 webhook type은 WebhookType enum에 포함됩니다. 각 example payload는 Event Types guide에서 확인할 수 있습니다.

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 log 조회 

API로 webhook log를 조회하려면:

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

이 페이지가 도움이 되었나요?