Campaign events
campaign_added
Add a campaign.
Payload
Key | Type | Description |
---|---|---|
event_name | string | Name of the event. For this 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 Optimizely Content Marketing Platform Open API. |
Example
{
"event_name": "campaign_added",
"data": {
"campaign": {
"id": "8q7f910551b00a722e0418830cee6612",
"links": {
"self": "https://api.welcomesoftware.com/v3/campaigns/8q7f910551b00a722e0418830cee6612"
}
}
}
}
campaign_metadata_modified
Modify the following properties of a campaign.
- Title
- Description
- Start date
- End date
- Is archived
- Labels
- Owner
Payload
Key | Type | Description |
---|---|---|
event_name | string | Name of the event. For this 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 Optimizely Content Marketing Platform Open API. |
Example
{
"event_name": "campaign_metadata_modified",
"data": {
"campaign": {
"id": "8q7f910551b00a722e0418830cee6612",
"links": {
"self": "https://api.welcomesoftware.com/v3/campaigns/8q7f910551b00a722e0418830cee6612"
}
}
}
}
campaign_brief_added
Add a brief to a campaign.
Payload
Key | Type | Description |
---|---|---|
event_name | string | Name of the event. For this 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 Optimizely Content Marketing Platform Open API. |
data[campaign][links][brief] | string | URL to fetch the campaign's brief through Optimizely Content Marketing Platform Open API. |
Example
{
"event_name": "campaign_brief_added",
"data": {
"campaign": {
"id": "8q7f910551b00a722e0418830cee6612",
"links": {
"self": "https://api.welcomesoftware.com/v3/campaigns/8q7f910551b00a722e0418830cee6612",
"brief": "https://api.welcomesoftware.com/v3/campaigns/8q7f910551b00a722e0418830cee6612/brief",
}
}
}
}
campaign_brief_removed
Remove a brief from a campaign.
Payload
Key | Type | Description |
---|---|---|
event_name | string | Name of the event. For this 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 Optimizely Content Marketing Platform Open API. |
Example
{
"event_name": "campaign_brief_removed",
"data": {
"campaign": {
"id": "8q7f910551b00a722e0418830cee6612",
"links": {
"self": "https://api.welcomesoftware.com/v3/campaigns/8q7f910551b00a722e0418830cee6612"
}
}
}
}
campaign_brief_modified
Modify a brief of a campaign.
Payload
Key | Type | Description |
---|---|---|
event_name | string | Name of the event. For this 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 Optimizely Content Marketing Platform Open API. |
data[campaign][links][brief] | string | URL to fetch the campaign's brief through Optimizely Content Marketing Platform Open API. |
Example
{
"event_name": "campaign_brief_modified",
"data": {
"campaign": {
"id": "8q7f910551b00a722e0418830cee6612",
"links": {
"self": "https://api.welcomesoftware.com/v3/campaigns/8q7f910551b00a722e0418830cee6612",
"brief": "https://api.welcomesoftware.com/v3/campaigns/8q7f910551b00a722e0418830cee6612/brief"
}
}
}
}
Updated 10 days ago