> ## Documentation Index > Fetch the complete documentation index at: https://docs.withampersand.com/llms.txt > Use this file to discover all available pages before exploring further. # Braze ## What's supported ### Supported actions This connector supports: * [Read Actions](/read-actions), including full historic backfill and incremental read for `contacts` only. * [Write Actions](/write-actions). * [Proxy Actions](/proxy-actions), using the base URL `https://rest.{{.restInstanceId}}.braze.com`. ### Supported Objects The Braze connector supports reading from the following objects: * [catalogs](https://www.braze.com/docs/api/endpoints/catalogs/catalog_management/synchronous/get_list_catalogs) * [cdi/integrations](https://www.braze.com/docs/api/endpoints/cdi/get_integration_list) * [email/hard\_bounces](https://www.braze.com/docs/api/endpoints/email/get_list_hard_bounces) * [email/unsubscribes](https://www.braze.com/docs/api/endpoints/email/get_query_unsubscribed_email_addresses) * [campaigns](https://www.braze.com/docs/api/endpoints/export/campaigns/get_campaigns) * [canvas](https://www.braze.com/docs/api/endpoints/export/canvas/get_canvases) * [events/list](https://www.braze.com/docs/api/endpoints/export/custom_events/get_custom_events) * [events](https://www.braze.com/docs/api/endpoints/export/custom_events/get_custom_events_data) * [purchases/product\_list](https://www.braze.com/docs/api/endpoints/export/purchases/get_list_product_id) * [segments](https://www.braze.com/docs/api/endpoints/export/segments/get_segment) * [custom\_attributes](https://www.braze.com/docs/api/endpoints/export/custom_attributes/get_custom_attributes) * [messages/scheduled\_broadcasts](https://www.braze.com/docs/api/endpoints/messaging/schedule_messages/get_messages_scheduled) * [preference\_center/v1/list](https://www.braze.com/docs/api/endpoints/preference_center/get_list_preference_center) * [sms/invalid\_phone\_numbers](https://www.braze.com/docs/api/endpoints/sms/get_query_invalid_numbers) * [content\_blocks/list](https://www.braze.com/docs/api/endpoints/templates/content_blocks_templates/get_list_email_content_blocks) * [templates/email/list](https://www.braze.com/docs/api/endpoints/templates/email_templates/get_list_email_templates) The Braze connector supports writing to the following objects: * [catalogs](https://www.braze.com/docs/api/endpoints/catalogs/catalog_management/synchronous/post_create_catalog) * [email/status](https://www.braze.com/docs/api/endpoints/email/post_email_subscription_status) * [email/bounce/remove](https://www.braze.com/docs/api/endpoints/email/post_remove_hard_bounces) * [email/spam/remove](https://www.braze.com/docs/api/endpoints/email/post_remove_spam) * [email/blocklist](https://www.braze.com/docs/api/endpoints/email/post_blocklist) * [users/export/ids](https://www.braze.com/docs/api/endpoints/export/user_data/post_users_identifier) * [users/export/segment](https://www.braze.com/docs/api/endpoints/export/user_data/post_users_segment) * [users/export/global\_control\_group](https://www.braze.com/docs/api/endpoints/export/user_data/post_users_global_control_group) * [campaigns/duplicate](https://www.braze.com/docs/api/endpoints/messaging/duplicate_messages/post_duplicate_campaigns) * [canvas/duplicate](https://www.braze.com/docs/api/endpoints/messaging/duplicate_messages/post_duplicate_canvases) * [messages/schedule/create](https://www.braze.com/docs/api/endpoints/messaging/schedule_messages/post_schedule_messages) * [campaigns/trigger/schedule/create](https://www.braze.com/docs/api/endpoints/messaging/schedule_messages/post_schedule_triggered_campaigns) * [canvas/trigger/schedule/create](https://www.braze.com/docs/api/endpoints/messaging/schedule_messages/post_schedule_triggered_canvases) * [messages/schedule/update](https://www.braze.com/docs/api/endpoints/messaging/schedule_messages/post_update_scheduled_messages) * [campaigns/trigger/schedule/update](https://www.braze.com/docs/api/endpoints/messaging/schedule_messages/post_update_scheduled_triggered_campaigns/#prerequisites) * [canvas/trigger/schedule/update](https://www.braze.com/docs/api/endpoints/messaging/schedule_messages/post_update_scheduled_triggered_canvases) * [sends/id/create](https://www.braze.com/docs/api/endpoints/messaging/send_messages/post_create_send_ids) * [messages/send](https://www.braze.com/docs/api/endpoints/messaging/send_messages/post_send_messages) * [campaigns/trigger/send](https://www.braze.com/docs/api/endpoints/messaging/send_messages/post_send_triggered_campaigns) * [canvas/trigger/send](https://www.braze.com/docs/api/endpoints/messaging/send_messages/post_send_triggered_canvases) * [preference\_center/v1](https://www.braze.com/docs/api/endpoints/preference_center/post_create_preference_center) * [scim/v2/Users](https://www.braze.com/docs/api/endpoints/scim/post_create_user_account) * [sms/invalid\_phone\_numbers/remove](https://www.braze.com/docs/api/endpoints/sms/post_remove_invalid_numbers) * [subscription/status/set](https://www.braze.com/docs/api/endpoints/subscription_groups/post_update_user_subscription_group_status) * [v2/subscription/status/set](https://www.braze.com/docs/api/endpoints/subscription_groups/post_update_user_subscription_group_status_v2) * [content\_blocks/create](https://www.braze.com/docs/api/endpoints/templates/content_blocks_templates/post_create_email_content_block) * [content\_blocks/update](https://www.braze.com/docs/api/endpoints/templates/content_blocks_templates/post_update_content_block) * [templates/email/create](https://www.braze.com/docs/api/endpoints/templates/email_templates/post_create_email_template) * [templates/email/update](https://www.braze.com/docs/api/endpoints/templates/email_templates/post_update_email_template) * [campaigns/translations](https://www.braze.com/docs/api/endpoints/translations/campaigns/put_update_translation_campaign) * [canvas/translations](https://www.braze.com/docs/api/endpoints/translations/canvas/put_update_translation_canvas) * [templates/email/translations](https://www.braze.com/docs/api/endpoints/translations/email_templates/put_update_template) * [users/alias/new](https://www.braze.com/docs/api/endpoints/user_data/post_user_alias) * [users/alias/update](https://www.braze.com/docs/api/endpoints/user_data/post_users_alias_update) * [users/identify](https://www.braze.com/docs/api/endpoints/user_data/post_user_identify) * [users/track](https://www.braze.com/docs/api/endpoints/user_data/post_user_track) * [users/track/sync](https://www.braze.com/docs/api/endpoints/user_data/post_user_track_synchronous) * [users/delete](https://www.braze.com/docs/api/endpoints/user_data/post_user_delete) * [users/merge](https://www.braze.com/docs/api/endpoints/user_data/post_users_merge) * [users/external\_ids/rename](https://www.braze.com/docs/api/endpoints/user_data/external_id_migration/post_external_ids_rename) * [users/external\_ids/remove](https://www.braze.com/docs/api/endpoints/user_data/external_id_migration/post_external_ids_remove) ### Example integration For an example manifest file of a Braze integration, visit our [samples repo on Github](https://github.com/amp-labs/samples/blob/main/braze/amp.yaml). ## Before You Get Started ### Creating an API key for Braze [Click here](https://www.braze.com/docs/api/basics/#creating-rest-api-keys) for more information about generating an API key for Braze. The UI components will display this link, so that your users can successfully create API keys. The Rest Instance ID can also be found on the same page. Braze API key ## Using the connector This connector uses API Key auth, which means that you do not need to set up a Provider App before getting started. Provider apps are only required for providers that use OAuth2 Authorization Code grant type. To start integrating with Braze: * Create a manifest file like the [example](https://github.com/amp-labs/samples/blob/main/braze/amp.yaml). * Deploy it using the [amp CLI](/cli/overview). * If you are using Read Actions, create a [destination](/destinations). * Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component. The UI component will prompt the customer for an API key. * Start using the connector! * If your integration has [Read Actions](/read-actions), you'll start getting webhook messages. * If your integration has [Write Actions](/write-actions), you can start making API calls to our Write API. * If your integration has [Proxy Actions](/proxy-actions), you can start making Proxy API calls.