Webhook-Events und Payloads - Topsort Documentation

Beispiel-Event-Antwort

Unten ist eine Beispiel-Webhook-Event-Antwort für ein Kampagnen-Update. Die Felder, die allen Events gemeinsam sind:

channel: Der Typ des aufgetretenen Events
timestamp: Wann das Event aufgetreten ist
id: Eindeutige ID für das Event, die zur Deduplizierung verwendet werden kann
payload: Die Payload enthält die Details des Events und variiert je nach Event, was unten im Detail behandelt wird

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

Kampagnenerstellung

Wird ausgelöst, wenn eine Kampagne erstellt wird. Für die vollständige Payload-Spezifikation siehe die Campaign Create API-Antwort.

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

Kampagnen-Update

Wird ausgelöst, wenn eine Kampagne aktualisiert wird. Für die vollständige Payload-Spezifikation siehe die Campaign Update API-Antwort.

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

Kampagnenlöschung

Wird ausgelöst, wenn eine Kampagne gelöscht wird.

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

Verwendung von Webhooks Create auctions

⌘I