Knowledge Base
Webhook Event and Payloads
Below is an example of a webhook event response for a campaign update. Common fields for all events are:
channel
: The type of the event that occurredtimestamp
: When the event occurredid
: Unique id for the event which can be used for deduplicationpayload
: The payload contains the details of the event and will vary depending on the event, which is covered in detail below
{ "channel": "campaign:update", "timestamp": "2024-10-31T14:42:55.759185Z", "id": "gUo", "payload": { "name": "My campaign", "campaign_id": "edac69a3-3ca2-41d6-af9e-08d3126099b4" }}
Campaign Creation
Triggered when a campaign is created. To see the full specification of the payload, see the Campaign Create API response.
{ "channel": "campaign:create", "timestamp": "2024-10-31T14:42:55.759185Z", "id": "gUo", "payload": { "name": "My campaign", "campaign_id": "edac69a3-3ca2-41d6-af9e-08d3126099b4" }}
Campaign Update
Triggered when a campaign is updated. To see the full specification of the payload, see the Campaign Update by ID API response.
{ "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" }}
Campaign Deletion
Triggered when a campaign is deleted.
{ "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" }}