Node.js / Braze Endpoints / Sending Campaign Messages via API Triggered Delivery
Back to Collection Items
var os = require('os');
if (os.platform() == 'win32') {
if (os.arch() == 'ia32') {
var chilkat = require('@chilkat/ck-node21-win-ia32');
} else {
var chilkat = require('@chilkat/ck-node21-win64');
}
} else if (os.platform() == 'linux') {
if (os.arch() == 'arm') {
var chilkat = require('@chilkat/ck-node21-arm');
} else if (os.arch() == 'x86') {
var chilkat = require('@chilkat/ck-node21-linux32');
} else {
var chilkat = require('@chilkat/ck-node21-linux64');
}
} else if (os.platform() == 'darwin') {
if (os.arch() == 'arm64') {
var chilkat = require('@chilkat/ck-node21-mac-m1');
} else {
var chilkat = require('@chilkat/ck-node21-macosx');
}
}
function chilkatExample() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var http = new chilkat.Http();
var success;
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "campaign_id": "campaign_identifier",
// "send_id": "send_identifier",
// "trigger_properties": "",
// "broadcast": false,
// "audience": {
// "AND": [
// {
// "custom_attribute": {
// "custom_attribute_name": "eye_color",
// "comparison": "equals",
// "value": "blue"
// }
// },
// {
// "custom_attribute": {
// "custom_attribute_name": "favorite_foods",
// "comparison": "includes_value",
// "value": "pizza"
// }
// },
// {
// "OR": [
// {
// "custom_attribute": {
// "custom_attribute_name": "last_purchase_time",
// "comparison": "less_than_x_days_ago",
// "value": 2
// }
// },
// {
// "push_subscription_status": {
// "comparison": "is",
// "value": "opted_in"
// }
// }
// ]
// },
// {
// "email_subscription_status": {
// "comparison": "is_not",
// "value": "subscribed"
// }
// },
// {
// "last_used_app": {
// "comparison": "after",
// "value": "2019-07-22T13:17:55+0000"
// }
// }
// ]
// },
// "recipients": {
// "user_alias": {
// "alias_name": "example_name",
// "alias_label": "example_label"
// },
// "external_user_id": "external_user_identifier",
// "trigger_properties": "",
// "send_to_existing_only": true,
// "attributes": ""
// }
// }
var json = new chilkat.JsonObject();
json.UpdateString("campaign_id","campaign_identifier");
json.UpdateString("send_id","send_identifier");
json.UpdateString("trigger_properties","");
json.UpdateBool("broadcast",false);
json.UpdateString("audience.AND[0].custom_attribute.custom_attribute_name","eye_color");
json.UpdateString("audience.AND[0].custom_attribute.comparison","equals");
json.UpdateString("audience.AND[0].custom_attribute.value","blue");
json.UpdateString("audience.AND[1].custom_attribute.custom_attribute_name","favorite_foods");
json.UpdateString("audience.AND[1].custom_attribute.comparison","includes_value");
json.UpdateString("audience.AND[1].custom_attribute.value","pizza");
json.UpdateString("audience.AND[2].OR[0].custom_attribute.custom_attribute_name","last_purchase_time");
json.UpdateString("audience.AND[2].OR[0].custom_attribute.comparison","less_than_x_days_ago");
json.UpdateInt("audience.AND[2].OR[0].custom_attribute.value",2);
json.UpdateString("audience.AND[2].OR[1].push_subscription_status.comparison","is");
json.UpdateString("audience.AND[2].OR[1].push_subscription_status.value","opted_in");
json.UpdateString("audience.AND[3].email_subscription_status.comparison","is_not");
json.UpdateString("audience.AND[3].email_subscription_status.value","subscribed");
json.UpdateString("audience.AND[4].last_used_app.comparison","after");
json.UpdateString("audience.AND[4].last_used_app.value","2019-07-22T13:17:55+0000");
json.UpdateString("recipients.user_alias.alias_name","example_name");
json.UpdateString("recipients.user_alias.alias_label","example_label");
json.UpdateString("recipients.external_user_id","external_user_identifier");
json.UpdateString("recipients.trigger_properties","");
json.UpdateBool("recipients.send_to_existing_only",true);
json.UpdateString("recipients.attributes","");
http.SetRequestHeader("Content-Type","application/json");
// Adds the "Authorization: Bearer {{api_key}}" header.
http.AuthToken = "{{api_key}}";
// resp: HttpResponse
var resp = http.PostJson3("https://rest.iad-01.braze.com/campaigns/trigger/send","application/json",json);
if (http.LastMethodSuccess == false) {
console.log(http.LastErrorText);
return;
}
console.log(resp.StatusCode);
console.log(resp.BodyStr);
}
chilkatExample();
Curl Command
curl -X POST
-H "Content-Type: application/json"
-H "Authorization: Bearer {{api_key}}"
-d '{
"campaign_id": "campaign_identifier",
"send_id": "send_identifier",
"trigger_properties": "",
"broadcast": false,
"audience": {
"AND": [
{
"custom_attribute": {
"custom_attribute_name": "eye_color",
"comparison": "equals",
"value": "blue"
}
},
{
"custom_attribute": {
"custom_attribute_name": "favorite_foods",
"comparison": "includes_value",
"value": "pizza"
}
},
{
"OR": [
{
"custom_attribute": {
"custom_attribute_name": "last_purchase_time",
"comparison": "less_than_x_days_ago",
"value": 2
}
},
{
"push_subscription_status": {
"comparison": "is",
"value": "opted_in"
}
}
]
},
{
"email_subscription_status": {
"comparison": "is_not",
"value": "subscribed"
}
},
{
"last_used_app": {
"comparison": "after",
"value": "2019-07-22T13:17:55+0000"
}
}
]
},
"recipients": {
"user_alias": {
"alias_name" : "example_name",
"alias_label" : "example_label"
},
"external_user_id": "external_user_identifier",
"trigger_properties": "",
"send_to_existing_only": true,
"attributes": ""
}
}'
https://rest.iad-01.braze.com/campaigns/trigger/send
Postman Collection Item JSON
{
"name": "Sending Campaign Messages via API Triggered Delivery",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Authorization",
"type": "text",
"value": "Bearer {{api_key}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"campaign_id\": \"campaign_identifier\",\n\t\"send_id\": \"send_identifier\",\n\t\"trigger_properties\": \"\",\n\t\"broadcast\": false,\n\t\"audience\": {\n \"AND\": [\n {\n \"custom_attribute\": {\n \"custom_attribute_name\": \"eye_color\",\n \"comparison\": \"equals\",\n \"value\": \"blue\"\n }\n },\n {\n \"custom_attribute\": {\n \"custom_attribute_name\": \"favorite_foods\",\n \"comparison\": \"includes_value\",\n \"value\": \"pizza\"\n }\n },\n {\n \"OR\": [\n {\n \"custom_attribute\": {\n \"custom_attribute_name\": \"last_purchase_time\",\n \"comparison\": \"less_than_x_days_ago\",\n \"value\": 2\n }\n },\n {\n \"push_subscription_status\": {\n \"comparison\": \"is\",\n \"value\": \"opted_in\"\n }\n }\n ]\n },\n {\n \"email_subscription_status\": {\n \"comparison\": \"is_not\",\n \"value\": \"subscribed\"\n }\n },\n {\n \"last_used_app\": {\n \"comparison\": \"after\",\n \"value\": \"2019-07-22T13:17:55+0000\"\n }\n }\n ]\n },\n\t\"recipients\": {\n \t\"user_alias\": {\n \t\t\"alias_name\" : \"example_name\",\n \t\t\"alias_label\" : \"example_label\"\n \t},\n\t\"external_user_id\": \"external_user_identifier\",\n\t\"trigger_properties\": \"\",\n\t\"send_to_existing_only\": true,\n \"attributes\": \"\"\n }\n}\n"
},
"url": {
"raw": "https://{{instance_url}}/campaigns/trigger/send",
"protocol": "https",
"host": [
"{{instance_url}}"
],
"path": [
"campaigns",
"trigger",
"send"
]
},
"description": "API Triggered Delivery allows you to house message content inside of the Braze dashboard while dictating when a message is sent, and to whom via your API.\n\nThe send endpoint allows you to send immediate, ad-hoc messages to designated users. If you are targeting a segment, a record of your request will be stored in the Developer Console. Please note that to send messages with this endpoint, you must have a Campaign ID, created when you build an API Triggered Campaign.\n\n### Request Parameters\n| Parameter | Required | Data Type | Description |\n| --------- | ---------| --------- | ----------- |\n|`campaign_id`|Required|String|See campaign identifier|\n|`send_id`| Optional | String | See send identifier |\n|`trigger_properties`|Optional|Object|Personalization key value pairs that will apply to all users in this request|\n|`broadcast`|Optional|Boolean|See broadcast -- defaults to false on 8/31/17, must be set to true if \"recipients\" is omitted|\n|`audience`|Optional|Connected audience object|See connected audience|\n|`recipients`|Optional|Array|If not provided and broadcast is not set to 'false', message will send to the entire segment targeted by the campaign|\n\n### Request Components\n- [Campaign Identifier](https://www.braze.com/docs/api/identifier_types/)\n- [Broadcast](https://www.braze.com/docs/api/parameters/#broadcast)\n- [Connected Audience](https://www.braze.com/docs/api/objects_filters/connected_audience/)\n- [Recipients](https://www.braze.com/docs/api/objects_filters/recipient_object/)\n- [User Alias Object](https://www.braze.com/docs/api/objects_filters/user_alias_object/)\n- [User Attributes Object](https://www.braze.com/docs/api/objects_filters/user_attributes_object/)\n- [API Parameters](https://www.braze.com/docs/api/parameters)\n\nThe recipients array may contain up to 50 objects, with each object containing a single `external_user_id` string and `trigger_properties` object.\n\nWhen `send_to_existing_only` is `true`, Braze will only send the message to existing users. When `send_to_existing_only` is `false` and a user with the given `id` does not exist, Braze will create a user with that id and attributes before sending the message.\n\nFor more information on the \"broadcast\" flag, check out [Broadcast](https://www.braze.com/docs/api/parameters/#broadcast) within our [API Parameters](https://www.braze.com/docs/api/parameters) documentation.\n\n## Response Details\nMessage sending endpoint responses will include the message’s `dispatch_id` for reference back to the dispatch of the message. The `dispatch_id` is the id of the message dispatch (unique id for each ‘transmission’ sent from the Braze platform). \n\n## Create Send Endpoint\n\n__Using the Attributes Object in Campaigns__\n\nBraze has a Messaging Object called `Attributes` that will allow you to add, create, or update attributes and values for a user before you send them an API Triggered Campaigns using the `campaign/trigger/send` endpoint as this API call will process the User Attributes object before it processes and sends the campaign. This helps minimize the risk of there being issues caused by race conditions."
},
"response": [
]
}
