Standard Event Trigger
Overview
The Standard Event Trigger endpoint provides the same functionality as the HTTP POST endpoint, except the Standard Event Trigger endpoint requires authentication using OAuth 2.0, and supports JSON and XML messages. As with the HTTP POST, the Standard Event Trigger allows you to send only one record at a time for each API request message.
The Standard Event Trigger endpoint requires the use of an API Post. The API Post includes a Data Map, which provides data handling instructions, such as where to store the inbound data contained within the API request, and whether this data should be used to update existing records and / or create new records.
When defining an Event-triggered Campaign, the platform allows you to use that API Post as the triggering mechanism. Upon receipt of a message that references this API Post, the system will deploy the Campaign. The platform will load or update the database prior to deploying the Campaign, which allows you to use data from your database when building your message content.
Endpoint (North America): https://api.eccmp.com/services2/api/Recipients
Endpoint (Europe): https://api.ccmp.eu/services2/api/Recipients
Endpoint (Japan): https://api.marketingsuite.jp/services2/api/Recipients
Note: This endpoint is sometimes referred to as the "Recipients" endpoint, but that name can be misleading. This endpoint can be used to load data into any table, not just into your "Recipient" table.
For more details on how to set up an Standard Event Trigger API request, please see the Standard Data Load API Technical Guide.
The following diagram depicts the processing flow for deploying a Campaign via the Standard Event Trigger endpoint.
Pre-requisites
The Standard Event Trigger endpoint requires the following:
Data Map -- The Data Map provides data handling instructions, such as where to store the inbound data contained within the API request message, and whether this data should be used to update existing records and / or create new records.
API Post -- The API Post serves as the triggering mechanism for the Campaign. The API Post must contain all expected fields in the request message. In addition, the "REST API Only" check box should be checked. You must also publish the API Post to make it available.
Campaign -- You must define and launch an Event-triggered Campaign that uses the above API Post as the event trigger.
POST Method
The Standard Event Trigger endpoint supports the following POST operation. This endpoint allows you to load a record into your marketing database, and trigger the deployment of an Event-triggered Campaign. The request must include the following:
The Object Reference ID of the API Post.
The data to be loaded, sent using Name / Value pairs. For the field names, be sure to use the system "Column Name," and not the "Display Name."
Click hereClick here to see a sample request message in JSON format.
{
"apiPostId": "2515",
"enable_validation": "true",
"validate_on_error": "true",
"data": [
{
"name": "email",
"value": "mary.smith@cheetahdigital.com"
},
{
"name": "name_first",
"value": "Mary"
},
{
"name": "name_last",
"value": "Smith"
},
{
"name": "pk_recip_id",
"value": "2119297"
}
]
}
Back to API Category - Campaign Deployment