> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Braze

> How to set up the Braze connector, plus the actions and events that are available.

![Braze](https://stackone-logos.com/api/braze/filled/svg)

v1.2.1[See changelog](https://docs.stackone.com/connectors/braze/changelog.md)

[98 actions](#actions) · [105 events](#events) · 1 auth method

Marketing

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/braze/guides/connector-profile/api-key.md)
>
> Uses a Braze REST API key. Actions run with the permissions selected on the key, and the key can be restricted to specif...

Optionally, configure receiving Events for Braze into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/braze/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/braze/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

campaigns.data\_series

campaigns.details

campaigns.list

campaigns.translations.get

campaigns.translations.update

campaigns.trigger.schedule.create

campaigns.trigger.schedule.delete

campaigns.trigger.schedule.update

campaigns.trigger.send

canvas.data\_series

canvas.data\_summary

canvas.details

canvas.list

canvas.translations.get

canvas.translations.update

canvas.trigger.schedule.create

canvas.trigger.schedule.delete

canvas.trigger.schedule.update

canvas.trigger.send

catalogs.add\_items

catalogs.create

catalogs.create\_fields

catalogs.create\_item

catalogs.delete

catalogs.delete\_fields

catalogs.delete\_item

catalogs.delete\_items

catalogs.get

catalogs.get\_item

catalogs.get\_items

catalogs.replace\_item

catalogs.replace\_items

catalogs.update\_item

catalogs.update\_items

cdi.integration\_job\_status

cdi.integration\_list

cdi.integration\_sync

content\_blocks.create

content\_blocks.info

content\_blocks.list

content\_blocks.translations.get

content\_blocks.translations.update

content\_blocks.update

custom\_attributes.get

email.bounce.remove

email.hard\_bounces

email.status

email.unsubscribe

events.data\_series

events.list

kpi.dau.data\_series

kpi.mau.data\_series

kpi.new\_users.data\_series

kpi.uninstalls.data\_series

messages.live\_activity.update

messages.schedule.create

messages.schedule.delete

messages.schedule.update

messages.schedule\_broadcasts

messages.send

preference\_center.get

preference\_center.list

preference\_center.update

preference\_center.user.get

purchases.product\_list

purchases.quantity\_series

purchases.revenue\_series

segments.data\_series

segments.details

segments.list

sends.data\_series

sends.id.create

sessions.data\_series

sms.invalid\_phone\_numbers

sms.invalid\_phone\_numbers.remove

subscription.groups.get

subscription.status.get

subscription.status.set

templates.email.create

templates.email.info

templates.email.list

templates.email.translations.get

templates.email.translations.update

templates.email.update

transactional.send

users.alias.new

users.alias.update

users.delete

users.export.global\_control\_group

users.export.ids

users.export.segment

users.external\_ids.remove

users.external\_ids.rename

users.identify

users.merge

users.track

No scopes found

98 actions

ActionDescriptionRequired scopes

List Campaigns`braze_list_campaigns`

Export list of campaigns with names and API identifiers

`campaigns.list`

Get Campaign Details`braze_get_campaign_details`

Retrieve relevant information about a specific campaign

`campaigns.details`

List Canvas`braze_list_canvas`

Export list of Canvas workflows with names and API identifiers

`canvas.list`

Get Canvas Details`braze_get_canvas_details`

Get details for a specific Canvas workflow

`canvas.details`

Get Canvas Analytics`braze_get_canvas_analytics`

Get analytics data series for a specific Canvas workflow

`canvas.data_series`

Get Canvas Summary`braze_get_canvas_summary`

Get analytics summary for a specific Canvas workflow

`canvas.data_summary`

Track Users`braze_track_users`

Record custom events, purchases, and update user profile attributes

`users.track`

Export Users By Identifier`braze_export_users_by_identifier`

Export user profile data by user identifier

`users.export.ids`

Delete Users`braze_delete_users`

Delete user profiles (permanent, cannot be undone)

`users.delete`

Identify Users`braze_identify_users`

Identify unidentified (alias-only) users with external ID

`users.identify`

Merge Users`braze_merge_users`

Merge one user profile into another user profile

`users.merge`

Create User Alias`braze_create_user_alias`

Create new user aliases for existing users

`users.alias.new`

Rename External IDs`braze_rename_external_ids`

Rename users' external IDs

`users.external_ids.rename`

Remove Deprecated External IDs`braze_remove_deprecated_external_ids`

Remove deprecated external IDs from user profiles

`users.external_ids.remove`

Update User Alias`braze_update_user_alias`

Update existing user aliases

`users.alias.update`

List Catalogs`braze_list_catalogs`

Return list of catalogs in a workspace

`catalogs.get`

Create Catalog`braze_create_catalog`

Create a new product catalog

`catalogs.create`

Get Catalog Item`braze_get_catalog_item`

Return a catalog item and its content

`catalogs.get_item`

Create Catalog Item`braze_create_catalog_item`

Create an item in a catalog

`catalogs.create_item`

Update Catalog Item`braze_update_catalog_item`

Update an item in your catalog or create if not found

`catalogs.replace_item`

Delete Catalog Item`braze_delete_catalog_item`

Delete an item in your catalog

`catalogs.delete_item`

Delete Catalog`braze_delete_catalog`

Delete a catalog

`catalogs.delete`

Edit Catalog Item`braze_edit_catalog_item`

Edit an item in your catalog

`catalogs.update_item`

List Catalog Items`braze_list_catalog_items`

Return multiple catalog items and their content

`catalogs.get_items`

Create Catalog Items Bulk`braze_create_catalog_items_bulk`

Create multiple items in your catalog (max 50 items)

`catalogs.add_items`

Update Catalog Items Bulk`braze_update_catalog_items_bulk`

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

`catalogs.replace_items`

Edit Catalog Items Bulk`braze_edit_catalog_items_bulk`

Edit multiple items in your catalog (max 50 items)

`catalogs.update_items`

Delete Catalog Items Bulk`braze_delete_catalog_items_bulk`

Delete multiple items in your catalog (max 50 items)

`catalogs.delete_items`

Create Catalog Fields`braze_create_catalog_fields`

Create new fields for a catalog

`catalogs.create_fields`

Delete Catalog Field`braze_delete_catalog_field`

Delete a field from a catalog

`catalogs.delete_fields`

List Segments`braze_list_segments`

Export list of segments with names and API identifiers

`segments.list`

Get Segment Details`braze_get_segment_details`

Retrieve relevant information about a specific segment

`segments.details`

List Email Templates`braze_list_email_templates`

Get list of available email templates

`templates.email.list`

List Content Blocks`braze_list_content_blocks`

List available Content Blocks

`content_blocks.list`

Get Email Template`braze_get_email_template`

Get information about a specific email template

`templates.email.info`

Create Email Template`braze_create_email_template`

Create email templates on the Braze dashboard

`templates.email.create`

Update Email Template`braze_update_email_template`

Update email templates on the Braze dashboard

`templates.email.update`

Get Content Block`braze_get_content_block`

Get information about a specific content block

`content_blocks.info`

Create Content Block`braze_create_content_block`

Create a new content block on the Braze dashboard

`content_blocks.create`

Update Content Block`braze_update_content_block`

Update an existing content block on the Braze dashboard

`content_blocks.update`

List Custom Events`braze_list_custom_events`

Export list of custom events

`events.list`

List Products`braze_list_products`

Export list of products purchased in your app

`purchases.product_list`

Get KPI - Daily Active Users`braze_get_kpi_dau`

Retrieve series of total daily active users over time

`kpi.dau.data_series`

Get KPI - Monthly Active Users`braze_get_kpi_mau`

Retrieve series of total monthly active users over time

`kpi.mau.data_series`

Get KPI - New Users`braze_get_kpi_new_users`

Retrieve series of new users per day

`kpi.new_users.data_series`

Get Campaign Analytics`braze_get_campaign_analytics`

Retrieve campaign analytics data over time

`campaigns.data_series`

Get Segment Analytics`braze_get_segment_analytics`

Retrieve daily series of estimated segment size over time

`segments.data_series`

Get Custom Events Analytics`braze_get_custom_events_analytics`

Retrieve series of occurrences of a custom event over time

`events.data_series`

Get Purchases Analytics`braze_get_purchases_analytics`

Retrieve total number of purchases over time

`purchases.quantity_series`

Get Revenue Analytics`braze_get_revenue_analytics`

Retrieve total revenue over time

`purchases.revenue_series`

Get Sessions Analytics`braze_get_sessions_analytics`

Retrieve series of number of sessions over time

`sessions.data_series`

Get KPI - Uninstalls`braze_get_kpi_uninstalls`

Retrieve series of total uninstalls over time

`kpi.uninstalls.data_series`

Export Users By Segment`braze_export_users_by_segment`

Export user data for a specific segment

`users.export.segment`

Export Users Global Control Group`braze_export_users_global_control_group`

Export user data for the global control group

`users.export.global_control_group`

List Custom Attributes`braze_list_custom_attributes`

Export list of custom attributes

`custom_attributes.get`

Get Send Analytics`braze_get_send_analytics`

Retrieve analytics for a specific campaign send

`sends.data_series`

List User Subscription Groups`braze_list_user_subscription_groups`

List and get subscription groups of a user

`subscription.groups.get`

Get User Subscription Group Status`braze_get_user_subscription_group_status`

Get the subscription state of a user in a subscription group

`subscription.status.get`

Update User Subscription Group Status`braze_update_user_subscription_group_status`

Update the subscription state of a user in a subscription group

`subscription.status.set`

Update User Subscription Group Status V2`braze_update_user_subscription_group_status_v2`

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

`subscription.status.set`

Query Hard Bounced Emails`braze_query_hard_bounced_emails`

Pull a list of email addresses that have hard bounced

`email.hard_bounces`

Query Unsubscribed Emails`braze_query_unsubscribed_emails`

Return emails that have unsubscribed during the time period

`email.unsubscribe`

Change Email Subscription Status`braze_change_email_subscription_status`

Set the email subscription state for your users

`email.status`

Remove Hard Bounced Emails`braze_remove_hard_bounced_emails`

Remove email addresses from the hard bounce list

`email.bounce.remove`

Send Messages`braze_send_messages`

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

`messages.send`

List Scheduled Messages`braze_list_scheduled_messages`

View upcoming scheduled campaigns and Canvases

`messages.schedule_broadcasts`

Schedule Messages`braze_schedule_messages`

Schedule messages to be sent at a designated time

`messages.schedule.create`

Update Scheduled Messages`braze_update_scheduled_messages`

Update scheduled messages that were created in the dashboard

`messages.schedule.update`

Delete Scheduled Messages`braze_delete_scheduled_messages`

Cancel scheduled messages that were created via API

`messages.schedule.delete`

Send Transactional Message`braze_send_transactional_message`

Send transactional messages via a triggered campaign

`transactional.send`

Send Triggered Campaign`braze_send_triggered_campaign`

Send API-triggered campaign messages

`campaigns.trigger.send`

Send Triggered Canvas`braze_send_triggered_canvas`

Send API-triggered Canvas messages

`canvas.trigger.send`

Create Send ID`braze_create_send_id`

Create a send ID for message send tracking

`sends.id.create`

Schedule Triggered Campaign`braze_schedule_triggered_campaign`

Schedule an API-triggered campaign for future delivery

`campaigns.trigger.schedule.create`

Schedule Triggered Canvas`braze_schedule_triggered_canvas`

Schedule an API-triggered Canvas for future delivery

`canvas.trigger.schedule.create`

Update Scheduled Triggered Campaign`braze_update_scheduled_triggered_campaign`

Update a scheduled API-triggered campaign

`campaigns.trigger.schedule.update`

Update Scheduled Triggered Canvas`braze_update_scheduled_triggered_canvas`

Update a scheduled API-triggered Canvas

`canvas.trigger.schedule.update`

Delete Scheduled Triggered Campaign`braze_delete_scheduled_triggered_campaign`

Delete a scheduled API-triggered campaign

`campaigns.trigger.schedule.delete`

Delete Scheduled Triggered Canvas`braze_delete_scheduled_triggered_canvas`

Delete a scheduled API-triggered Canvas

`canvas.trigger.schedule.delete`

Update Live Activity`braze_update_live_activity`

Update an iOS Live Activity via push notification

`messages.live_activity.update`

Query Invalid Phone Numbers`braze_query_invalid_phone_numbers`

Pull a list of invalid phone numbers. Requires either phone\_numbers OR both start\_date AND end\_date together — Braze rej...

`sms.invalid_phone_numbers`

Remove Invalid Phone Numbers`braze_remove_invalid_phone_numbers`

Remove invalid phone numbers from blocklist

`sms.invalid_phone_numbers.remove`

List Preference Centers`braze_list_preference_centers`

List available preference centers

`preference_center.list`

Get Preference Center`braze_get_preference_center`

Get details of a specific preference center

`preference_center.get`

Create Preference Center`braze_create_preference_center`

Create a new preference center

`preference_center.update`

Update Preference Center`braze_update_preference_center`

Update an existing preference center

`preference_center.update`

Create Preference Center URL`braze_create_preference_center_url`

Create URL for a preference center for a specific user

`preference_center.user.get`

List CDI Integrations`braze_list_cdi_integrations`

Return list of existing integrations

`cdi.integration_list`

Trigger CDI Sync`braze_trigger_cdi_sync`

Trigger a sync for a CDI integration

`cdi.integration_sync`

Get CDI Job Sync Status`braze_get_cdi_job_sync_status`

Return the sync status for a CDI integration

`cdi.integration_job_status`

View Campaign Translations`braze_view_campaign_translations`

View bulk translations for a specific campaign

`campaigns.translations.get`

Update Campaign Translations`braze_update_campaign_translations`

Update translations for a specific campaign

`campaigns.translations.update`

View Canvas Translations`braze_view_canvas_translations`

View bulk translations for a specific Canvas

`canvas.translations.get`

Update Canvas Translations`braze_update_canvas_translations`

Update translations for a specific Canvas

`canvas.translations.update`

View Email Template Translations`braze_view_email_template_translations`

View bulk translations for a specific email template

`templates.email.translations.get`

Update Email Template Translations`braze_update_email_template_translations`

Update translations for a specific email template

`templates.email.translations.update`

View Content Block Translations`braze_view_content_block_translations`

View bulk translations for a specific content block

`content_blocks.translations.get`

Update Content Block Translations`braze_update_content_block_translations`

Update translations for a specific content block

`content_blocks.translations.update`

## Events

Tags

Select all
|
Clear

Agents

Banners

Campaigns

Canvases

Content Cards

Content Optimizer

Emails

Feature Flags

In-App Messages

LINE Messages

Landing Pages

Live Activities

Push Notifications

RCS Messages

SMS

Sessions

Subscription Groups

Surveys

Users

Webhooks

WhatsApp Messages

No tags found

105 events

EventDescriptionTags

Active Check`braze_active_check`

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

Webhooks

Email Abort`braze_webhook_email_abort`

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

EmailsWebhooks

Email Bounce`braze_webhook_email_bounce`

Fired when an Internet Service Provider returns a hard bounce.

EmailsWebhooks

Email Click`braze_webhook_email_click`

Fired when a user clicks an email.

EmailsWebhooks

Email Deferral`braze_webhook_email_deferral`

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

EmailsWebhooks

Email Delivery`braze_webhook_email_delivery`

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

EmailsWebhooks

Email Mark As Spam`braze_webhook_email_mark_as_spam`

Fired when the end user hits the "spam" button on the email.

EmailsWebhooks

Email Open`braze_webhook_email_open`

Fired when a user opens an email.

EmailsWebhooks

Email Retry`braze_webhook_email_retry`

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

EmailsWebhooks

Email Send`braze_webhook_email_send`

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

EmailsWebhooks

Email Soft Bounce`braze_webhook_email_soft_bounce`

Fired when an Internet Service Provider returns a soft bounce.

EmailsWebhooks

Email Unsubscribe`braze_webhook_email_unsubscribe`

Fired when the end user has clicked "unsubscribe" from the email.

EmailsWebhooks

Transactional Email Sent`braze_webhook_transactional_email_sent`

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

EmailsWebhooks

Transactional Email Processed`braze_webhook_transactional_email_processed`

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

EmailsWebhooks

Transactional Email Delivered`braze_webhook_transactional_email_delivered`

Fired when the inbox provider accepts the transactional email.

EmailsWebhooks

Transactional Email Bounced`braze_webhook_transactional_email_bounced`

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

EmailsWebhooks

Transactional Email Aborted`braze_webhook_transactional_email_aborted`

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

EmailsWebhooks

LINE Abort`braze_webhook_line_abort`

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

LINE MessagesWebhooks

LINE Click`braze_webhook_line_click`

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

LINE MessagesWebhooks

LINE Inbound Receive`braze_webhook_line_inbound_receive`

Fired when a LINE message is received from a user.

LINE MessagesWebhooks

LINE Retry`braze_webhook_line_retry`

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

LINE MessagesWebhooks

LINE Send`braze_webhook_line_send`

Fired when a LINE message is sent to LINE.

LINE MessagesWebhooks

RCS Abort`braze_webhook_rcs_abort`

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

RCS MessagesWebhooks

RCS Click`braze_webhook_rcs_click`

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

RCS MessagesWebhooks

RCS Delivery`braze_webhook_rcs_delivery`

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

RCS MessagesWebhooks

RCS Inbound Received`braze_webhook_rcs_inbound_received`

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

RCS MessagesWebhooks

RCS Read`braze_webhook_rcs_read`

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

RCS MessagesWebhooks

RCS Rejection`braze_webhook_rcs_rejection`

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

RCS MessagesWebhooks

RCS Send`braze_webhook_rcs_send`

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

RCS MessagesWebhooks

SMS Abort`braze_webhook_sms_abort`

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

SMSWebhooks

SMS Carrier Send`braze_webhook_sms_carrier_send`

Fired when an SMS is sent to the carrier.

SMSWebhooks

SMS Delivery`braze_webhook_sms_delivery`

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

SMSWebhooks

SMS Delivery Failure`braze_webhook_sms_delivery_failure`

Fired when an SMS experiences delivery failure.

SMSWebhooks

SMS Inbound Received`braze_webhook_sms_inbound_received`

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

SMSWebhooks

SMS Rejection`braze_webhook_sms_rejection`

Fired when an SMS send gets rejected by the carrier.

SMSWebhooks

SMS Retry`braze_webhook_sms_retry`

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

SMSWebhooks

SMS Send`braze_webhook_sms_send`

Fired when Braze sends an SMS message to a user.

SMSWebhooks

SMS Short Link Click`braze_webhook_sms_short_link_click`

Fired when a user clicks an SMS short link.

SMSWebhooks

Webhook Abort`braze_webhook_webhook_abort`

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

Webhooks

Webhook Failure`braze_webhook_webhook_failure`

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

Webhooks

Webhook Retry`braze_webhook_webhook_retry`

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

Webhooks

Webhook Send`braze_webhook_webhook_send`

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

Webhooks

WhatsApp Abort`braze_webhook_whatsapp_abort`

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

WhatsApp MessagesWebhooks

WhatsApp Tracked Link Click`braze_webhook_whatsapp_tracked_link_click`

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

WhatsApp MessagesWebhooks

WhatsApp Delivery`braze_webhook_whatsapp_delivery`

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

WhatsApp MessagesWebhooks

WhatsApp Failure`braze_webhook_whatsapp_failure`

Fired when WhatsApp cannot deliver the message to the user.

WhatsApp MessagesWebhooks

WhatsApp Inbound Received`braze_webhook_whatsapp_inbound_received`

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

WhatsApp MessagesWebhooks

WhatsApp Read`braze_webhook_whatsapp_read`

Fired when a WhatsApp message is read by the user.

WhatsApp MessagesWebhooks

WhatsApp Retry`braze_webhook_whatsapp_retry`

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

WhatsApp MessagesWebhooks

WhatsApp Send`braze_webhook_whatsapp_send`

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

WhatsApp MessagesWebhooks

Banner Abort`braze_webhook_banner_abort`

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

BannersWebhooks

Banner Click`braze_webhook_banner_click`

Fired when a user clicks a banner.

BannersWebhooks

Banner Dismissal`braze_webhook_banner_dismissal`

Fired when a user dismisses a banner.

BannersWebhooks

Banner Impression`braze_webhook_banner_impression`

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

BannersWebhooks

Content Card Abort`braze_webhook_content_card_abort`

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

Content CardsWebhooks

Content Card Click`braze_webhook_content_card_click`

Fired when a user clicks a Content Card.

Content CardsWebhooks

Content Card Dismiss`braze_webhook_content_card_dismiss`

Fired when a user dismisses a Content Card.

Content CardsWebhooks

Content Card Impression`braze_webhook_content_card_impression`

Fired when a user views a Content Card.

Content CardsWebhooks

Content Card Send`braze_webhook_content_card_send`

Fired when a Content Card gets sent to a user.

Content CardsWebhooks

Feature Flag Experiment Impression`braze_webhook_feature_flag_experiment_impression`

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

Feature FlagsWebhooks

In-App Message Abort`braze_webhook_in_app_message_abort`

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

In-App MessagesWebhooks

In-App Message Click`braze_webhook_in_app_message_click`

Fired when a user clicks an in-app message.

In-App MessagesWebhooks

In-App Message Impression`braze_webhook_in_app_message_impression`

Fired when a user views an in-app message.

In-App MessagesWebhooks

Landing Page Click`braze_webhook_landing_page_click`

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

Landing PagesWebhooks

Landing Page Form Submission`braze_webhook_landing_page_form_submission`

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

Landing PagesWebhooks

Landing Page Impression`braze_webhook_landing_page_impression`

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

Landing PagesWebhooks

Live Activity Outcome`braze_webhook_live_activity_outcome`

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

Live ActivitiesWebhooks

Live Activity Send`braze_webhook_live_activity_send`

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

Live ActivitiesWebhooks

Push Notification Abort`braze_webhook_push_notification_abort`

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

Push NotificationsWebhooks

Push Notification Bounce`braze_webhook_push_notification_bounce`

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

Push NotificationsWebhooks

Push Notification iOS Foreground Open`braze_webhook_push_notification_ios_foreground_open`

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

Push NotificationsWebhooks

Push Notification Open`braze_webhook_push_notification_open`

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

Push NotificationsWebhooks

Push Notification Retry`braze_webhook_push_notification_retry`

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

Push NotificationsWebhooks

Push Notification Send`braze_webhook_push_notification_send`

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

Push NotificationsWebhooks

Survey Response`braze_webhook_survey_response`

Fired when an end user submits a survey response.

SurveysWebhooks

Live Activity Push To Start Token Change`braze_webhook_live_activity_push_to_start_token_change`

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

Live ActivitiesWebhooks

Live Activity Update Token Change`braze_webhook_live_activity_update_token_change`

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

Live ActivitiesWebhooks

Push Notification Token State Change`braze_webhook_push_notification_token_state_change`

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

Push NotificationsWebhooks

Agent Executed`braze_webhook_agent_executed`

Fired when a BrazeAI Agent Console agent is executed.

AgentsWebhooks

Tool Invocation`braze_webhook_tool_invocation`

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

AgentsWebhooks

Content Optimizer Component Store Update`braze_webhook_content_optimizer_component_store_update`

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

Content OptimizerWebhooks

Campaign Conversion`braze_webhook_campaign_conversion`

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

CampaignsWebhooks

Campaign Control Group Enrollment`braze_webhook_campaign_control_group_enrollment`

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

CampaignsWebhooks

Canvas Conversion`braze_webhook_canvas_conversion`

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

CanvasesWebhooks

Canvas Entry`braze_webhook_canvas_entry`

Fired when a user enters into the Canvas.

CanvasesWebhooks

Canvas Content Optimizer Step Conversion`braze_webhook_canvas_content_optimizer_step_conversion`

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

CanvasesWebhooks

Canvas Content Optimizer Step Send`braze_webhook_canvas_content_optimizer_step_send`

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

CanvasesWebhooks

Canvas Exit Match Audience`braze_webhook_canvas_exit_match_audience`

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

CanvasesWebhooks

Canvas Exit Perform Event`braze_webhook_canvas_exit_perform_event`

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

CanvasesWebhooks

Canvas Experiment Step Conversion`braze_webhook_canvas_experiment_step_conversion`

Fired when a user converts for a Canvas experiment step.

CanvasesWebhooks

Canvas Experiment Split Entry`braze_webhook_canvas_experiment_split_entry`

Fired when a user enters a Canvas experiment step path.

CanvasesWebhooks

Canvas Step Progression`braze_webhook_canvas_step_progression`

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

CanvasesWebhooks

Uninstall`braze_webhook_uninstall`

Fired when a user uninstalls an app.

Subscription GroupsWebhooks

Global Subscription State Change`braze_webhook_global_subscription_state_change`

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

Subscription GroupsWebhooks

Subscription Group State Change`braze_webhook_subscription_group_state_change`

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

Subscription GroupsWebhooks

Custom Event`braze_webhook_custom_event`

Fired when a specific custom event is triggered.

UsersWebhooks

Install Attribution`braze_webhook_install_attribution`

Fired when an app installation is attributed to a source.

UsersWebhooks

Location`braze_webhook_location`

Fired when a user visits a specified location.

UsersWebhooks

Purchase`braze_webhook_purchase`

Fired when a user makes a purchase.

UsersWebhooks

First Session`braze_webhook_first_session`

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

SessionsWebhooks

Session End`braze_webhook_session_end`

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

SessionsWebhooks

Session Start`braze_webhook_session_start`

Fired when a user starts a session.

SessionsWebhooks

User Delete Request`braze_webhook_user_delete_request`

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

UsersWebhooks

User Orphan`braze_webhook_user_orphan`

Fired when a user profile is orphaned because it was merged into another profile (properties.orphaned\_by\_id identifies t...

UsersWebhooks

User Profile Update`braze_webhook_user_profile_update`

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

UsersWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.