API Usage

See our here for an overview of required API permissions for Braze Signals
A batch send is triggered via Braze's /canvas/trigger/send
- We trigger the send using email to identify the user, but this requires providing prioritization to properly find the correct user. If a user does not exist with this email address, a new profile is created in Braze. Profile creation is initiated in this request by sending send_to_existing_only as false and providing attributes with the email
- https://www.braze.com/docs/api/endpoints/messaging/send_messages/post_send_triggered_canvases

Sample API Request

{
  "canvas_id": "38e3347e-98ad-4596-aace-ff695e0c696f",
  "recipients": [
    {
      "email": "[email protected]",
      "prioritization": [
        "identified",
        "most_recently_updated"
      ],
      "send_to_existing_only": false,
      "attributes": {
        "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"
    }
  ]
}