Écoutez les événements avec des webhooks

Les webhooks fournissent un moyen pour Zonos de notifier proactivement vos systèmes externes chaque fois que certains événements se produisent. Lorsque l'événement souscrit se produit, Zonos enverra une requête HTTP POST à l'URL du webhook que vous spécifiez. Le corps de la requête contiendra les détails de l'événement, permettant à votre système de gérer l'événement de manière programmatique.

Les webhooks sont utiles pour intégrer Zonos avec d'autres plateformes, déclencher des flux de travail automatisés et maintenir les données synchronisées entre les systèmes en temps réel. Par exemple, vous pourriez utiliser des webhooks pour :

• Mettre à jour votre système de gestion des commandes lorsque qu'une commande est créée dans Zonos
• Notifier votre fournisseur de traitement lorsque qu'un envoi est annulé
• Enregistrer les changements de statut des commandes internationales à des fins d'audit

Types de webhook 

Tous les types de webhook disponibles sont inclus dans l'énumération WebhookType. Des exemples de charges utiles pour chacun peuvent être trouvés dans notre guide Types d'événements.

Création de webhooks 

Pour créer un webhook via l'API :

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

Modifier les détails du webhook 

Pour modifier un webhook existant via l'API :

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

Voir les journaux de webhook 

Pour voir les journaux de webhook via l'API :

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