customerId.
Campaign payloads use camelCase property names, such as
campaignId and eventId. The other catalogues use PascalCase.A property with no value is left out of the payload, not sent as null. Only eventId, campaignId and timestamp are always present.Dates are UTC with second precision, in the form yyyy-MM-ddTHH:mm:ssZ.Field reference
| Event | Raised when |
|---|---|
| Campaign Created | A campaign is created, including when an existing campaign is copied |
| Campaign Updated | A campaign is changed, including when one of its steps is added, updated or removed |
| Campaign Deleted | A campaign is deleted |
eventId is composed differently.
Schemas
- Campaign Created
- Campaign Updated
- Campaign Deleted
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Payload emitted when a campaign is created in TurboFlow.",
"type": "object",
"required": ["eventId", "campaignId", "timestamp"],
"properties": {
"eventId": {
"type": "string",
"description": "Computed event identifier, also used as the Service Bus message id: CampaignCreated-{campaignId}."
},
"campaignId": {
"type": "string",
"description": "Unique identifier of the campaign."
},
"campaignName": {
"type": "string",
"description": "Name of the campaign."
},
"campaignDescription": {
"type": "string",
"description": "Description of the campaign."
},
"externalReferenceId": {
"type": "string",
"description": "Reference used to identify the campaign in an external system."
},
"authorId": {
"type": "string",
"description": "Identifier of the user whose change raised the event."
},
"authorName": {
"type": "string",
"description": "Full name of the user whose change raised the event."
},
"startDate": {
"type": "string",
"format": "date-time",
"description": "Start of the campaign validity period, when one is set."
},
"endDate": {
"type": "string",
"format": "date-time",
"description": "End of the campaign validity period, when one is set."
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the event occurred."
}
}
}
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Payload emitted when a campaign is changed in TurboFlow, including when one of its steps is added, updated or removed.",
"type": "object",
"required": ["eventId", "campaignId", "timestamp"],
"properties": {
"eventId": {
"type": "string",
"description": "Computed event identifier, also used as the Service Bus message id: CampaignUpdated-{campaignId}-{timestamp}."
},
"campaignId": {
"type": "string",
"description": "Unique identifier of the campaign."
},
"campaignName": {
"type": "string",
"description": "Name of the campaign."
},
"campaignDescription": {
"type": "string",
"description": "Description of the campaign."
},
"externalReferenceId": {
"type": "string",
"description": "Reference used to identify the campaign in an external system."
},
"authorId": {
"type": "string",
"description": "Identifier of the user whose change raised the event."
},
"authorName": {
"type": "string",
"description": "Full name of the user whose change raised the event."
},
"startDate": {
"type": "string",
"format": "date-time",
"description": "Start of the campaign validity period, when one is set."
},
"endDate": {
"type": "string",
"format": "date-time",
"description": "End of the campaign validity period, when one is set."
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the event occurred."
}
}
}
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Payload emitted when a campaign is deleted in TurboFlow.",
"type": "object",
"required": ["eventId", "campaignId", "timestamp"],
"properties": {
"eventId": {
"type": "string",
"description": "Computed event identifier, also used as the Service Bus message id: CampaignDeleted-{campaignId}."
},
"campaignId": {
"type": "string",
"description": "Unique identifier of the campaign."
},
"campaignName": {
"type": "string",
"description": "Name the campaign had when it was deleted."
},
"campaignDescription": {
"type": "string",
"description": "Description the campaign had when it was deleted."
},
"externalReferenceId": {
"type": "string",
"description": "Reference used to identify the campaign in an external system."
},
"authorId": {
"type": "string",
"description": "Identifier of the user who deleted the campaign."
},
"authorName": {
"type": "string",
"description": "Full name of the user who deleted the campaign."
},
"startDate": {
"type": "string",
"format": "date-time",
"description": "Start of the campaign validity period, when one is set."
},
"endDate": {
"type": "string",
"format": "date-time",
"description": "End of the campaign validity period, when one is set."
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the event occurred."
}
}
}
Related
- Offer events — the offers a campaign holds.
- Challenge events — the challenges a campaign holds.
- OutboundAPI connection — how these events reach an endpoint in your system.