Événements et payloads de webhook - Topsort Documentation

Exemple de réponse d’événement

Ci-dessous un exemple de réponse d’événement de webhook pour une mise à jour de campagne. Les champs communs à tous les événements sont :

channel : le type d’événement qui s’est produit
timestamp : quand l’événement s’est produit
id : ID unique pour l’événement qui peut être utilisé pour la déduplication
payload : le payload contient les détails de l’événement et variera en fonction de l’événement, ce qui est couvert en détail ci-dessous

{
  "channel": "campaign:update",
  "timestamp": "2024-10-31T14:42:55.759185Z",
  "id": "gUo",
  "payload": {
    "name": "My campaign",
    "campaign_id": "edac69a3-3ca2-41d6-af9e-08d3126099b4"
  }
}

Création de campagne

Déclenché lorsqu’une campagne est créée. Pour voir la spécification complète du payload, consultez la réponse de l’API Campaign Create.

{
  "channel": "campaign:create",
  "timestamp": "2024-10-31T14:42:55.759185Z",
  "id": "gUo",
  "payload": {
    "name": "My campaign",
    "campaign_id": "edac69a3-3ca2-41d6-af9e-08d3126099b4"
  }
}

Mise à jour de campagne

Déclenché lorsqu’une campagne est mise à jour. Pour voir la spécification complète du payload, consultez la réponse de l’API Campaign Update.

{
  "channel": "campaign:update",
  "timestamp": "2024-10-31T14:42:55.759185Z",
  "id": "gUo",
  "payload": {
    "name": "My new campaign name",
    "campaign_id": "edac69a3-3ca2-41d6-af9e-08d3126099b4"
  }
}

Suppression de campagne

Déclenché lorsqu’une campagne est supprimée.

{
  "channel": "campaign:delete",
  "timestamp": "2024-10-31T14:42:55.759185Z",
  "id": "gUo",
  "payload": {
    "name": "My campaign",
    "ad_format": "listing",
    "vendor_id": "2355d342-222e-4dc9-af92-81c3865b3b66",
    "campaign_id": "edac69a3-3ca2-41d6-af9e-08d3126099b4",
    "campaign_type": "autobidding",
    "marketplace_id": "ad666c53-b174-497a-b52f-77354947456c"
  }
}

Utilisation des webhooks Create auctions

⌘I