Export campaign status data
In an event-triggered campaign, Blueshift sends a message to the integrated app when a customer meets the trigger criteria. The execution status of this send, whether successful or unsuccessful, can be exported to a webhook.
How it works
- The status is exported only when a customer enters a campaign and qualifies for a trigger.
- A status update is sent for each trigger the customer qualifies for within the campaign.
- The status only indicates whether the message was successfully sent from Blueshift to the integrated app; it does not track delivery beyond that.
How to export execution status for event-triggered campaigns
To export execution status data to a webhook, go to Account Settings > Campaign Activity Export > Webhooks and configure the following settings:
| Field | Description |
| Event-triggered campaign status notifications |
Enable this setting to export execution details for event-triggered campaigns. The data is sent to the URL specified in the Execution status webhook URL field. |
| Execution status webhook URL |
Specify the webhook URL where execution details for event-triggered campaigns should be sent. |
Export selected campaign activities
Blueshift can export campaign activity each time a customer interacts with a marketing message. Depending on the selected events, Blueshift sends a notification whenever the event occurs.
For example, notifications can be triggered when a customer opens, clicks, unsubscribes, or a message bounces or gets delivered.
Notifications can be sent to Segment.com, mParticle, Mixpanel, Amplitude, or a custom webhook URL. This allows you to update analytics or route the data to other integrated platforms.
Important considerations
- Notifications are batched and sent every 1 minute.
- If campaign activity export is disabled, notifications will not be created or queued. However, campaign activities can still be downloaded as campaign reports.
How to export selected campaign activities
You can go to Account Settings > Campaign Activity Export > Webhooks to export selected campaign activities and configure the required settings.
| Field | Description |
| Messaging event notifications | Enable this setting to send selected event data in real-time to the destination specified in the Send notifications field. |
| Send notifications to |
Select the destination for event data. Options include:
|
| Webhook URL | Specify the URL where messaging event details (e.g., open, click, bounce) should be sent. |
| Authentication |
Select the authentication type:
|
| Username | Required if Basic HTTPS authentication is enabled. |
| Password | Required if Basic HTTPS authentication is enabled. |
| User ID | Applicable for Amplitude exports. Select the customer identifier to use as the User ID. |
| Select events to export | Choose the campaign events to export. |
Please make sure that you save your settings.
SMS event availability
Inbound message events for SMS channels are available only if you use Blueshift Full Service SMS or Sinch as your SMS provider. For more details, please take a look at 2-way SMS messaging.
Sample webhook notification payload
Below is an example of a batched webhook notification:
{
"batch": [
{
"action":"open",
"bucket_uuid":"e211ea94-8da6-43a5-b95b-c21ccfe4568c",
"campaign_exec_term":"on_going",
"campaign_id":"0835fbbb-4059-4172-bebc-6aafdaa7b44f",
"campaign_name":"Abandoned cart",
"campaign_uuid":"0845bbbb-4059-4172-bebc-6aafdaa7b44f",
"creative_uuid":"a533de05-1a32-4312-80da-7c5893fbd5a5",
"customer_id":"12345",
"email":"username@domain.com",
"event":"open",
"experiment_uuid":"ac09f565-9bd9-4f72-b5ea-6a143516f1f4",
"ip":"198.234.218.145",
"message_uuid":"3543b535-29ad-4144-a749-2340a5c694f0",
"trigger_timestamp":"2016-11-22T06:50:14+00:00",
"trigger_type":"EmailTrigger",
"trigger_uuid":"577a52f6-0678-4aa2-80f9-f819395aba07",
"user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10.9; rv:49.0) Gecko/20100101 Firefox/49.0",
"user_uuid":"9a4df219-e42c-4913-a3d9-917e9fb4dd6d",
"utm_campaign":"abandoned_cart",
"utm_content":"product-banner",
"utm_medium":"email",
"utm_source":"blueshift",
"utm_term":null
},
]
}JSON structure
This is a sample JSON. The payload may vary, and additional attributes may be included in future updates.
Comments
0 comments