DOCS

Webhooks

/

Слушайте события с помощью вебхуков

Получайте уведомления о событиях в реальном времени для вашей интеграции с Zonos.

Вебхуки предоставляют способ для Zonos проактивно уведомлять ваши внешние системы, когда происходят определенные события. Когда происходит подписанное событие, Zonos отправит HTTP POST запрос на указанный вами URL вебхука. Тело запроса будет содержать детали события, позволяя вашей системе обрабатывать событие программно.

Вебхуки полезны для интеграции Zonos с другими платформами, запуска автоматизированных рабочих процессов и поддержания синхронизации данных между системами в реальном времени. Например, вы можете использовать вебхуки для:

  • Обновления вашей системы управления заказами, когда заказ создается в Zonos
  • Уведомления вашего поставщика выполнения, когда отправка отменяется
  • Логирования изменений статуса международных заказов для аудиторских целей

Типы вебхуков 

Все доступные типы вебхуков включены в перечисление 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
      }
    }
  }
}

Была ли эта страница полезной?


На этой странице: