DOCS

Webhooks

/

通过webhooks监听事件

获取您的Zonos集成的实时事件通知。

Webhooks提供了一种方式,让Zonos在某些事件发生时主动通知您的外部系统。当订阅的事件发生时,Zonos将向您指定的webhook URL发送HTTP POST请求。请求体将包含事件详细信息,使您的系统能够以编程方式处理该事件。

Webhooks对于将Zonos与其他平台集成、触发自动化工作流以及实时保持系统间数据同步非常有用。例如,您可以使用webhooks来:

  • 在Zonos中创建订单时更新您的订单管理系统
  • 在发货被取消时通知您的履行提供商
  • 记录国际订单的状态变化以便审计

Webhook类型 

所有可用的webhook类型都包含WebhookType枚举中。每种类型的示例有效负载可以在我们事件类型指南中找到。

创建webhooks 

要通过API创建webhook:

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
  }
}

查看 Webhook 日志 

要通过 API 查看 Webhook 日志:

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
      }
    }
  }
}

这个页面有帮助吗?


有问题吗?

联系我们。