DOCS

Webhooks

/

Nasłuchuj zdarzeń za pomocą webhooków

Uzyskaj powiadomienia o zdarzeniach w czasie rzeczywistym dla swojej integracji z Zonos.

Webhooki zapewniają sposób, w jaki Zonos może proaktywnie powiadamiać Twoje zewnętrzne systemy, gdy zachodzą określone zdarzenia. Gdy wystąpi subskrybowane zdarzenie, Zonos wyśle żądanie HTTP POST do określonego przez Ciebie adresu URL webhooka. Treść żądania będzie zawierać szczegóły zdarzenia, co pozwoli Twojemu systemowi obsłużyć zdarzenie programowo.

Webhooki są przydatne do integracji Zonos z innymi platformami, uruchamiania zautomatyzowanych przepływów pracy oraz utrzymywania synchronizacji danych między systemami w czasie rzeczywistym. Na przykład, możesz użyć webhooków do:

  • Aktualizacji swojego systemu zarządzania zamówieniami, gdy zamówienie zostanie utworzone w Zonos
  • Powiadomienia swojego dostawcy realizacji, gdy przesyłka zostanie anulowana
  • Rejestrowania zmian statusu zamówień międzynarodowych w celach audytowych

Typy webhooków 

Wszystkie dostępne typy webhooków są zawarte w enumie WebhookType. Przykładowe ładunki dla każdego z nich można znaleźć w naszym przewodniku Typy zdarzeń.

Tworzenie webhooków 

Aby utworzyć webhook za pomocą 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
  }
}

Edytuj szczegóły webhooka 

Aby edytować istniejący webhook za pomocą 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
  }
}

Zobacz logi webhooków 

Aby zobaczyć logi webhooków za pomocą 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
      }
    }
  }
}

Czy ta strona była pomocna?