DOCS

Webhooks

/

Lắng nghe sự kiện với webhook

Nhận thông báo sự kiện theo thời gian thực cho tích hợp Zonos của bạn.

Webhook cung cấp một cách để Zonos chủ động thông báo cho các hệ thống bên ngoài của bạn bất cứ khi nào một số sự kiện nhất định xảy ra. Khi sự kiện đã đăng ký xảy ra, Zonos sẽ gửi một yêu cầu HTTP POST đến URL webhook mà bạn chỉ định. Nội dung yêu cầu sẽ chứa chi tiết sự kiện, cho phép hệ thống của bạn xử lý sự kiện một cách lập trình.

Webhook rất hữu ích cho việc tích hợp Zonos với các nền tảng khác, kích hoạt các quy trình tự động và giữ cho dữ liệu đồng bộ giữa các hệ thống theo thời gian thực. Ví dụ, bạn có thể sử dụng webhook để:

  • Cập nhật hệ thống quản lý đơn hàng của bạn khi một đơn hàng được tạo trong Zonos
  • Thông báo cho nhà cung cấp thực hiện của bạn khi một lô hàng bị hủy
  • Ghi lại các thay đổi trạng thái của các đơn hàng quốc tế cho mục đích kiểm toán

Các loại webhook 

Tất cả các loại webhook có sẵn đều được bao gồm trong enum WebhookType. Ví dụ về payload cho mỗi loại có thể được tìm thấy trong hướng dẫn Các loại sự kiện.

Tạo webhook 

Để tạo một webhook qua 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
  }
}

Chỉnh sửa chi tiết webhook 

Để chỉnh sửa một webhook hiện có thông qua 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
  }
}

Xem nhật ký webhook 

Để xem nhật ký webhook qua 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
      }
    }
  }
}

Trang này có hữu ích không?