DOCS

Webhooks

/

Lyt til begivenheder med webhooks

Få realtidsbegivenhedsnotifikationer til din Zonos integration.

Webhooks giver en måde for Zonos at proaktivt underrette dine eksterne systemer, når visse begivenheder finder sted. Når den abonnerede begivenhed opstår, vil Zonos sende en HTTP POST-anmodning til den webhook-URL, du angiver. Anmodningskroppen vil indeholde begivenhedsdetaljerne, så dit system kan håndtere begivenheden programmæssigt.

Webhooks er nyttige til at integrere Zonos med andre platforme, udløse automatiserede arbejdsgange og holde data synkroniseret på tværs af systemer i realtid. For eksempel kan du bruge webhooks til at:

  • Opdatere dit ordrehåndteringssystem, når en ordre oprettes i Zonos
  • Underrette din opfyldelsesudbyder, når en forsendelse annulleres
  • Logge statusændringer af internationale ordrer til revisionsformål

Webhook-typer 

Alle tilgængelige webhook-typer er inkluderet i WebhookType enum. Eksempelpayloads for hver kan findes i vores Begivenhedstyper guide.

Oprettelse af webhooks 

For at oprette en webhook via API'en:

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

Rediger webhook-detaljer 

For at redigere en eksisterende webhook via API'en:

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

Vis webhook-logfiler 

For at se webhook-logfiler via API'en:

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

Var denne side nyttig?