Campaign

13 min

campaign_added

A campaign was added.

Payload

Key	Type	Description
event_name	string	Name of the event. The value is campaign_added.
data	object	Data of the event.
data[campaign]	object	Data of the campaign associated with the event.
data[campaign][id]	string	Unique identifier of the campaign.
data[campaign][links]	object	Links related to the campaign.
data[campaign][links][self]	string	URL to fetch the campaign's details through the CMP Open API.
data[campaign][links][work_request]	string or null	URL to fetch the work request's details through the CMP Open API. The URL is available if a campaign was started from a work request. Otherwise, it is null.

Example

When a campaign is added:

{
  "event_name": "campaign_added",
  "data": {
    "campaign": {
      "id": "8q7f910551b00a722e0418830cee6612",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/campaigns/8q7f910551b00a722e0418830cee6612",
        "work_request": null
      }
    }
  }
}

When a campaign is added from a work request:

{
  "event_name": "campaign_added",
  "data": {
    "campaign": {
      "id": "8q7f910551b00a722e0418830cee6612",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/campaigns/8q7f910551b00a722e0418830cee6612",
        "work_request": "https://api.cmp.optimizely.com/v3/work-requests/9q7f910551b00a722e0418830cee6613"
      }
    }
  }
}

campaign_metadata_modified

Any of the following campaign properties are modified:

Title

Description

Start date

End date

Is archived

Labels

Owner

Payload

Key	Type	Description
event_name	string	Name of the event. The value is campaign_metadata_modified.
data	object	Data of the event.
data[campaign]	object	Data of the campaign associated with the event.
data[campaign][id]	string	Unique identifier of the campaign.
data[campaign][links]	object	Links related to the campaign.
data[campaign][links][self]	string	URL to fetch the campaign's details through the CMP Open API.

Example

{
  "event_name": "campaign_metadata_modified",
  "data": {
    "campaign": {
      "id": "8q7f910551b00a722e0418830cee6612",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/campaigns/8q7f910551b00a722e0418830cee6612"
      }
    }
  }
}

campaign_brief_added

A brief was added to a campaign.

Payload

Key	Type	Description
event_name	string	Name of the event. The value is campaign_brief_added.
data	object	Data of the event.
data[campaign]	object	Data of the campaign associated with the event.
data[campaign][id]	string	Unique identifier of the campaign.
data[campaign][links]	object	Links related to the campaign.
data[campaign][links][self]	string	URL to fetch the campaign's details through the CMP Open API.
data[campaign][links][brief]	string	URL to fetch the campaign's brief through the CMP Open API.

Example

{
  "event_name": "campaign_brief_added",
  "data": {
    "campaign": {
      "id": "8q7f910551b00a722e0418830cee6612",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/campaigns/8q7f910551b00a722e0418830cee6612",
        "brief": "https://api.cmp.optimizely.com/v3/campaigns/8q7f910551b00a722e0418830cee6612/brief"
      }
    }
  }
}

campaign_brief_removed

A campaign brief was removed.

Payload

Key	Type	Description
event_name	string	Name of the event. The value is campaign_brief_removed.
data	object	Data of the event.
data[campaign]	object	Data of the campaign associated with the event.
data[campaign][id]	string	Unique identifier of the campaign.
data[campaign][links]	object	Links related to the campaign.
data[campaign][links][self]	string	URL to fetch the campaign's details through the CMP Open API.

Example

{
  "event_name": "campaign_brief_removed",
  "data": {
    "campaign": {
      "id": "8q7f910551b00a722e0418830cee6612",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/campaigns/8q7f910551b00a722e0418830cee6612"
      }
    }
  }
}

campaign_brief_modified

A campaign brief was modified.

Payload

Key	Type	Description
event_name	string	Name of the event. The value is campaign_brief_modified.
data	object	Data of the event.
data[campaign]	object	Data of the campaign associated with the event.
data[campaign][id]	string	Unique identifier of the campaign.
data[campaign][links]	object	Links related to the campaign.
data[campaign][links][self]	string	URL to fetch the campaign's details through the CMP Open API.
data[campaign][links][brief]	string	URL to fetch the campaign's brief through the CMP Open API.

Example

{
  "event_name": "campaign_brief_modified",
  "data": {
    "campaign": {
      "id": "8q7f910551b00a722e0418830cee6612",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/campaigns/8q7f910551b00a722e0418830cee6612",
        "brief": "https://api.cmp.optimizely.com/v3/campaigns/8q7f910551b00a722e0418830cee6612/brief"
      }
    }
  }
}