Appearance

On this page

Campaign Started ​

Event ID ​

txt
campaigns.started

Event Description ​

The event triggers when campaign status changed to started.

Fields ​

FieldDescription
data.campaignInformation about campaign
data.campaign.titleCampaign name
data.campaign.statusCampaign status, can be only running
data.campaign.slugCampaign identifier used to access campaign info in public API
data.campaign.started_atCampaign started at datetime, in UTC timezone
data.appInformation about Application
data.app.uuidApp unique identifier
data.app.nameApplication name

Example Payload ​

json
{
  "event": {
    "id": "e7fe07b8-ae6d-440d-a3db-b20f4a267ce6",
    "type": "campaigns.started"
  },
  "data": {
    "campaign": {
      "title": "Campaign title",
      "status": "running",
      "slug": "campaign-slug",
      "started_at": "2023-01-01T10:00:00.00000Z"
    },
    "app": {
      "uuid": "81721046-5c8f-4b44-aeb8-dce0adb5c4e3",
      "name": "App Name"
    }
  }
}