Lyssna på händelser med webhooks

Webhooks ger ett sätt för Zonos att proaktivt meddela dina externa system när vissa händelser inträffar. När den prenumererade händelsen inträffar kommer Zonos att skicka en HTTP POST-förfrågan till den webhook-URL du anger. Begärans kropp kommer att innehålla händelsedetaljer, vilket gör att ditt system kan hantera händelsen programmässigt.

Webhooks är användbara för att integrera Zonos med andra plattformar, utlösa automatiserade arbetsflöden och hålla data synkroniserade över system i realtid. Till exempel kan du använda webhooks för att:

• Uppdatera ditt orderhanteringssystem när en beställning skapas i Zonos
• Meddela din uppfyllnadsleverantör när en försändelse avbryts
• Logga statusändringar av internationella beställningar för revisionsändamål

Webhook-typer 

Alla tillgängliga webhook-typer ingår i WebhookType enum. Exempel på payloads för varje kan hittas i vår Händelsetyper guide.

Skapa webhooks 

För att skapa en webhook via API:et:

mutation {
  webhookCreate(
    input: {
      url: "https://example.com/webhooks/zonos"
      type: ORDER_CREATED
      status: ENABLED
    }
  ) {
    id
    url
    type
    status
  }
}

Redigera webhook-detaljer 

För att redigera en befintlig webhook via API:et:

mutation {
  webhookUpdate(
    input: {
      id: "webhook-id"
      url: "https://example.com/webhooks/zonos"
      type: ORDER_CREATED
      status: ENABLED
    }
  ) {
    id
    url
    type
    status
  }
}

Visa webhook-loggar 

För att visa webhook-loggar via API:et:

query {
  webhookLogs(first: 20, after: "yyyyyyy", filter: { type: ORDER_CREATED }) {
    edges {
      node {
        id
        type
        url
        createdAt
        responseStatus
      }
    }
  }
}