HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityOptimizely GitHubOptimizely NuGetLog In

Campaign events

campaign_added

When a campaign is added.

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is campaign_added.
dataobjectData of the event.
data[campaign]objectData of the campaign associated with the event.
data[campaign][id]stringUnique identifier of the campaign.
data[campaign][links]objectLinks related to the campaign
data[campaign][links][self]stringURL to fetch the campaign's details through Welcome Open API.

Example

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

campaign_metadata_modified

When any of the following properties of a campaign is modified:

  • Title
  • Description
  • Start date
  • End date
  • Is archived
  • Labels
  • Owner

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is campaign_metadata_modified.
dataobjectData of the event.
data[campaign]objectData of the campaign associated with the event.
data[campaign][id]stringUnique identifier of the campaign.
data[campaign][links]objectLinks related to the campaign
data[campaign][links][self]stringURL to fetch the campaign's details through Welcome Open API.

Example

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

campaign_brief_added

When brief is added to a campaign.

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is campaign_brief_added.
dataobjectData of the event.
data[campaign]objectData of the campaign associated with the event.
data[campaign][id]stringUnique identifier of the campaign.
data[campaign][links]objectLinks related to the campaign
data[campaign][links][self]stringURL to fetch the campaign's details through Welcome Open API.
data[campaign][links][brief]stringURL to fetch the campaign's brief through Welcome 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

When brief is removed from a campaign.

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is campaign_brief_removed.
dataobjectData of the event.
data[campaign]objectData of the campaign associated with the event.
data[campaign][id]stringUnique identifier of the campaign.
data[campaign][links]objectLinks related to the campaign
data[campaign][links][self]stringURL to fetch the campaign's details through Welcome Open API.

Example

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

campaign_brief_modified

When brief of a campaign is modified.

Payload

KeyTypeDescription
event_namestringName of the event. For this event, the value is campaign_brief_modified.
dataobjectData of the event.
data[campaign]objectData of the campaign associated with the event.
data[campaign][id]stringUnique identifier of the campaign.
data[campaign][links]objectLinks related to the campaign
data[campaign][links][self]stringURL to fetch the campaign's details through Welcome Open API.
data[campaign][links][brief]stringURL to fetch the campaign's brief through Welcome 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"
            }
        }
    }
}

Did this page help you?