Integration Overview
API Usage
- See our here for an overview of required API permissions for Braze Signals
- Before sending, an API call (
users/export/ids) is made to ensure each recipient has a Brazeuser_aliaskeyed bywknd_email_id. This is necessary because the Canvas trigger endpoint expects a user identifier (alias/external_id) to address recipients. https://www.braze.com/docs/api/endpoints/export/user_data/post_users_identifier - If recipients are found without the Wunderkind alias:
- An API call (
/users/alias/new) is made to update users who don’t have an existingwknd_email_idalias. https://www.braze.com/docs/api/endpoints/user_data/post_user_alias - An additional API call is made (
/users/track) to ensure the alias is associated with an actual user/email before the Canvas send. https://www.braze.com/docs/api/endpoints/user_data/post_user_track - A small latency (10s) is encountered at the end of this flow to allow Braze to process the user updates before proceeding with the Canvas send.
- An API call (
- A batch send is triggered via Braze's
/canvas/trigger/sendhttps://www.braze.com/docs/api/endpoints/messaging/send_messages/post_send_triggered_canvases#prerequisites
Sample API Request
{
"canvas_id": "a3d9cdd8-9c3f-42bd-980e-78735e27f56a",
"recipients": [
{
"user_alias": {
"alias_name": "[email protected]",
"alias_label": "wknd_email_id"
},
"email": "[email protected]",
"canvas_entry_properties": {
"Origin": "wunderkind",
"DataOnly": "Y",
"UserType": "prospect",
"WkChannel": "email",
"WkPurpose": "product abandonment",
"WKCouponCode": "",
"WKCouponPurpose": "",
"Items": [
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com"
},
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com"
},
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com"
},
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com"
}
]
}
}
]
}Canvas Entry Properties by Canvas Type
Cart Abandonment
{
"Origin": "wunderkind",
"DataOnly": "Y",
"UserType": "prospect",
"WkOpen": "some-url.com",
"WkPurpose": "cart abandonment",
"WkChannel": "email",
"WKCouponCode": "",
"WKCouponPurpose": "",
"WkCartReplenUrl": "some-url.com",
"Items": [
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com"
},
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com"
},
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com"
},
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com"
}
]
}Product Abandonment
{
"Origin": "wunderkind",
"DataOnly": "Y",
"UserType": "prospect",
"WkOpen": "some-url.com",
"WkPurpose": "product abandonment",
"WkChannel": "email",
"WKCouponCode": "",
"WKCouponPurpose": "",
"Items": [
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com"
},
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com"
},
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com"
},
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com"
}
]
}Category Recap
{
"Origin": "wunderkind",
"DataOnly": "Y",
"UserType": "prospect",
"WkOpen": "some-url.com",
"WkPurpose": "category recap",
"WkChannel": "email",
"WKCouponCode": "",
"WKCouponPurpose": "",
"WkCategoryUrl": "some-category-url.com",
"Items": [
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com"
},
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com"
},
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com"
},
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com"
}
]
}Back in Stock
{
"Origin": "wunderkind",
"DataOnly": "Y",
"UserType": "prospect",
"WkOpen": "some-url.com",
"WkPurpose": "back in stock",
"WkChannel": "email",
"WKCouponCode": "",
"WKCouponPurpose": "",
"Items": [
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com"
},
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com"
},
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com"
},
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com"
}
]
}Price Drop
{
"Origin": "wunderkind",
"DataOnly": "Y",
"UserType": "prospect",
"WkOpen": "some-url.com",
"WkPurpose": "price drop",
"WkChannel": "email",
"WKCouponCode": "",
"WKCouponPurpose": "",
"Items": [
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com",
"WkPrice": "49.99",
"WKSalePrice": "39.99"
},
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com",
"WkPrice": "49.99",
"WKSalePrice": "39.99"
},
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com",
"WkPrice": "49.99",
"WKSalePrice": "39.99"
},
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com",
"WkPrice": "49.99",
"WKSalePrice": "39.99"
}
]
}Low Stock
{
"Origin": "wunderkind",
"DataOnly": "Y",
"UserType": "prospect",
"WkOpen": "some-url.com",
"WkPurpose": "low stock",
"WkChannel": "email",
"WKCouponCode": "",
"WKCouponPurpose": "",
"Items": [
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com",
"WkQuantity": "1"
},
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com",
"WkQuantity": "1"
},
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com",
"WkQuantity": "1"
},
{
"WkCopy": "Product name",
"WkId": "012345",
"WkImageUrl": "some-url.jpg",
"WkUrl": "some-url.com",
"WkQuantity": "1"
}
]
}Updated 5 days ago