DOCS

Webhooks

/

Luister naar gebeurtenissen met webhooks

Ontvang realtime gebeurtenismeldingen voor uw Zonos integratie.

Webhooks bieden een manier voor Zonos om uw externe systemen proactief te informeren wanneer bepaalde gebeurtenissen plaatsvinden. Wanneer de geabonneerde gebeurtenis zich voordoet, zal Zonos een HTTP POST-verzoek sturen naar de webhook-URL die u opgeeft. De aanvraagbody bevat de details van de gebeurtenis, zodat uw systeem de gebeurtenis programmatisch kan afhandelen.

Webhooks zijn nuttig voor het integreren van Zonos met andere platforms, het activeren van geautomatiseerde workflows en het synchroniseren van gegevens tussen systemen in realtime. U kunt bijvoorbeeld webhooks gebruiken om:

  • Uw orderbeheersysteem bij te werken wanneer een bestelling wordt aangemaakt in Zonos
  • Uw fulfilmentprovider te informeren wanneer een verzending wordt geannuleerd
  • Statuswijzigingen van internationale bestellingen te loggen voor auditdoeleinden

Webhook-types 

Alle beschikbare webhook-types zijn opgenomen in de WebhookType enum. Voorbeeldpayloads voor elk type zijn te vinden in onze Evenementtypes handleiding.

Webhooks maken 

Om een webhook via de API te maken:

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

Bewerk webhook-gegevens 

Om een bestaande webhook via de API te bewerken:

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

Bekijk webhook-logboeken 

Om webhook-logboeken via de API te bekijken:

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

Was deze pagina nuttig?