Braze

Export list of campaigns with names and API identifiers

Retrieve relevant information about a specific campaign

Export list of Canvas workflows with names and API identifiers

Get details for a specific Canvas workflow

Get analytics data series for a specific Canvas workflow

Get analytics summary for a specific Canvas workflow

Record custom events, purchases, and update user profile attributes

Export user profile data by user identifier

Delete user profiles (permanent, cannot be undone)

Identify unidentified (alias-only) users with external ID

Merge one user profile into another user profile

Create new user aliases for existing users

Rename users’ external IDs

Remove deprecated external IDs from user profiles

Update existing user aliases

Return list of catalogs in a workspace

Create a new product catalog

Return a catalog item and its content

Create an item in a catalog

Update an item in your catalog or create if not found

Delete an item in your catalog

Delete a catalog

Edit an item in your catalog

Return multiple catalog items and their content

Create multiple items in your catalog (max 50 items)

Update multiple items or create if not found (max 50 items)

Edit multiple items in your catalog (max 50 items)

Delete multiple items in your catalog (max 50 items)

Create new fields for a catalog

Delete a field from a catalog

Export list of segments with names and API identifiers

Retrieve relevant information about a specific segment

Get list of available email templates

List available Content Blocks

Get information about a specific email template

Create email templates on the Braze dashboard

Update email templates on the Braze dashboard

Get information about a specific content block

Create a new content block on the Braze dashboard

Update an existing content block on the Braze dashboard

Export list of custom events

Export list of products purchased in your app

Retrieve series of total daily active users over time

Retrieve series of total monthly active users over time

Retrieve series of new users per day

Retrieve campaign analytics data over time

Retrieve daily series of estimated segment size over time

Retrieve series of occurrences of a custom event over time

Retrieve total number of purchases over time

Retrieve total revenue over time

Retrieve series of number of sessions over time

Retrieve series of total uninstalls over time

Export user data for a specific segment

Export user data for the global control group

Export list of custom attributes

Retrieve analytics for a specific campaign send

List and get subscription groups of a user

Get the subscription state of a user in a subscription group

Update the subscription state of a user in a subscription group

Update the subscription state of a user in a subscription group (V2)

Pull a list of email addresses that have hard bounced

Return emails that have unsubscribed during the time period

Set the email subscription state for your users

Remove email addresses from the hard bounce list

Send immediate, one-off messages to designated users via API

View upcoming scheduled campaigns and Canvases

Schedule messages to be sent at a designated time

Update scheduled messages that were created in the dashboard

Cancel scheduled messages that were created via API

Send transactional messages via a triggered campaign

Send API-triggered campaign messages

Send API-triggered Canvas messages

Create a send ID for message send tracking

Schedule an API-triggered campaign for future delivery

Schedule an API-triggered Canvas for future delivery

Update a scheduled API-triggered campaign

Update a scheduled API-triggered Canvas

Delete a scheduled API-triggered campaign

Delete a scheduled API-triggered Canvas

Update an iOS Live Activity via push notification

Pull a list of invalid phone numbers. Requires either phone_numbers OR both start_date AND end_date together — Braze rej…

Remove invalid phone numbers from blocklist

List available preference centers

Get details of a specific preference center

Create a new preference center

Update an existing preference center

Create URL for a preference center for a specific user

Return list of existing integrations

Trigger a sync for a CDI integration

Return the sync status for a CDI integration

View bulk translations for a specific campaign

Update translations for a specific campaign

View bulk translations for a specific Canvas

Update translations for a specific Canvas

View bulk translations for a specific email template

Update translations for a specific email template

View bulk translations for a specific content block

Update translations for a specific content block

Responds with 200 OK to any Braze delivery that is neither a Currents batch nor a transactional postback.

Fired if an email message was aborted by Liquid abort logic or a similar rule.

Fired when an Internet Service Provider returns a hard bounce.

Fired when a user clicks an email.

Fired when an Internet Service Provider does not immediately deliver the email to a non-hard bounced email address and B…

Fired when an email made it successfully to the end user’s inbox.

Fired when the end user hits the “spam” button on the email.

Fired when a user opens an email.

Fired when a message is deprioritized or frequency capped and will be retried later within the configured retry window.

Fired when an email send request was successfully communicated between Braze and SendGrid.

Fired when an Internet Service Provider returns a soft bounce.

Fired when the end user has clicked “unsubscribe” from the email.

Fired when Braze successfully dispatches the transactional email to its email sending partner.

Fired when the email sending partner receives the transactional email and prepared it for the inbox provider.

Fired when the inbox provider accepts the transactional email.

Fired when the inbox provider rejects the transactional email (metadata.reason explains why).

Fired when Braze cannot dispatch the transactional email, for example a missing email address or abort logic (metadata.r…

Fired when a scheduled LINE message cannot be delivered, before sending to LINE.

Fired when a user clicks a link in a LINE message where the link’s domain matches the click tracking domain.

Fired when a LINE message is received from a user.

Fired when a message is deprioritized or frequency capped and will be retried later within the configured retry window.

Fired when a LINE message is sent to LINE.

Fired when an RCS send is interrupted due to an error detected within Braze, and the message is dropped.

Fired when the user interacts with an RCS message in a way that involves tapping or clicking on a UI element.

Fired when an RCS message is successfully delivered to a user’s mobile device.

Fired when Braze receives an RCS message that originates from the user.

Fired when a user opens an RCS message on their device, indicating that they have seen or read the message content.

Fired when an RCS message fails to be delivered to a user’s mobile device due to intervention by the carrier.

Fired when an RCS message is sent out of Braze to its last-mile delivery partners.

Fired if an SMS message was aborted by Liquid abort logic or a similar rule.

Fired when an SMS is sent to the carrier.

Fired when an SMS was successfully delivered to the user’s mobile phone.

Fired when an SMS experiences delivery failure.

Fired when one of your users sends an SMS to a phone number in one of your Braze SMS subscription groups.

Fired when an SMS send gets rejected by the carrier.

Fired when a message is deprioritized or frequency capped and will be retried later within the configured retry window.

Fired when Braze sends an SMS message to a user.

Fired when a user clicks an SMS short link.

Fired if a webhook message was aborted by Liquid abort logic or a similar rule.

Fired if a webhook message was delivered but failed with an error response from the endpoint.

Fired when a message is deprioritized or frequency capped and will be retried later within the configured retry window.

Fired when a webhook was processed and sent to the third party specified in that webhook.

Fired if a WhatsApp message was aborted by Liquid abort logic or a similar rule.

Fired when a user clicks a link or button in a WhatsApp message where the link’s domain matches the click tracking domai…

Fired when a WhatsApp message made it successfully to the user’s device.

Fired when WhatsApp cannot deliver the message to the user.

Fired when one of your users sends a WhatsApp message to a phone number in one of your Braze WhatsApp subscription group…

Fired when a WhatsApp message is read by the user.

Fired when a message is deprioritized or frequency capped and will be retried later within the configured retry window.

Fired when a send request was successfully communicated between Braze and WhatsApp.

Fired when an originally scheduled banner message was aborted for some reason.

Fired when a user clicks a banner.

Fired when a user dismisses a banner.

Fired when a user views a banner, including control group users when an impression is logged.

Fired if a Content Card message was aborted by Liquid abort logic or a similar rule.

Fired when a user clicks a Content Card.

Fired when a user dismisses a Content Card.

Fired when a user views a Content Card.

Fired when a Content Card gets sent to a user.

Fired whenever a user has had an opportunity to interact with your feature, or when they could have interacted if the fe…

Fired when an originally scheduled in-app message was aborted.

Fired when a user clicks an in-app message.

Fired when a user views an in-app message.

Fired when an end user clicks on select elements and form fields on a landing page.

Fired when an end user completes a form on a landing page and clicks on the button to submit the information.

Fired when an end user’s browser loads and displays a landing page.

Fired when Braze receives a response from a third-party provider (for example APNs) after a Live Activity request.

Fired when the Braze system makes a request to its provider regarding Live Activity.

Fired if a push notification message was aborted by Liquid abort logic or a similar rule.

Fired when an error is received from either Apple Push Notification Service or Firebase Cloud Messaging.

Fired when a user opens an iOS push notification while the app is in the foreground (legacy Obj-C SDK only; deprecated).

Fired when a user directly clicks on the push notification to open the application.

Fired when a message is deprioritized or frequency capped and will be retried later within the configured retry window.

Fired when Braze processes a push message for a user, communicating this to Apple Push Notification Service or Firebase…

Fired when an end user submits a survey response.

Fired when Braze syncs the Live Activity push to start token with the user.

Fired when Braze syncs Live Activity update token with the user.

Fired when a push token is inserted, updated, or removed.

Fired when a BrazeAI Agent Console agent is executed.

Fired when a BrazeAI agent invokes a tool (a function given to the LLM to fulfil an objective).

Fired when the Content Optimizer component store is updated with a component combination.

Fired when a user does an action that has been set as a conversion event in a campaign.

Fired when a user is enrolled in a control variant set on a multi-variant campaign.

Fired when a user does an action that has been set as a conversion event in Canvas.

Fired when a user enters into the Canvas.

Fired when a user converts on a Content Optimizer Canvas step.

Fired when a Content Optimizer Canvas step sends a message to a user.

Fired when a user has exited a Canvas by matching an audience.

Fired when a user has exited a Canvas by performing an event.

Fired when a user converts for a Canvas experiment step.

Fired when a user enters a Canvas experiment step path.

Fired when a user progresses through a step in a Canvas with some outcome.

Fired when a user uninstalls an app.

Fired when Braze receives a request to update the global subscription state of the user.

Fired when the subscription state of a user in a subscription group changes.

Fired when a specific custom event is triggered.

Fired when an app installation is attributed to a source.

Fired when a user visits a specified location.

Fired when a user makes a purchase.

Fired when a user starts their first session in your application.

Fired when a user exits your application, ending their current session.

Fired when a user starts a session.

Fired when Braze receives a request to delete a user profile.

Fired when a user profile is orphaned because it was merged into another profile (properties.orphaned_by_id identifies t…

Fired when a user profile or its attributes are updated (standard fields plus custom_attributes as a JSON string).