Skip to main content

Braze Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a sync or streaming data flow that sends data to a Braze location.
braze_api.png

Braze

Create a Braze Destination​

  1. Click the + icon on the Nexset that will be sent to the Braze destination, and select the Send to Destination option from the menu.

  2. Select the Braze connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Braze organization, and click Next; or, create a new Braze credential for use in this flow.

  3. In Nexla, Braze destinations can be created using pre-built endpoint templates, which expedite destination setup for common Braze endpoints. Each template is designed specifically for the corresponding Braze endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Braze destinations can also be configured manually, allowing you to send data to Braze endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Braze endpoints. Each template is designed specifically for the corresponding Braze endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Identify Users

    This endpoint identifies an unidentified (alias-only) user in your Braze account. Identifying a user requires an external_id to be included in the aliases to identify the object. Use this endpoint when you need to link anonymous user aliases to known user identities.

    • The endpoint uses POST requests to {instance_url}/users/identify where {instance_url} is your Braze REST instance URL from the credential configuration. The endpoint URL is automatically constructed based on your credential's instance URL configuration.
    • The endpoint sends data from your Nexset as the request body in JSON format. The request body is automatically transformed to include your Nexset records in the aliases_to_identify array. Each record in your Nexset will be included in the batch request body.
    • Batch mode is enabled for this endpoint. Multiple records from your Nexset will be grouped into batch requests, with up to 50 records per batch. This allows efficient processing of multiple user identifications in a single API call.
    • Ensure your Nexset data includes the required fields for user identification, including the external_id that will be used to identify the user.

    The request body must be properly formatted JSON that matches the Braze API specification for identifying users. The request body is automatically transformed to wrap your Nexset records in the aliases_to_identify array structure. The endpoint requires Bearer token authentication in the Authorization header, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is enabled (batch.mode: true) with a maximum of 50 records per batch (max.poll.records: 50), allowing efficient processing of multiple user identifications. For detailed information about identifying users, including required fields and request formats, see the Braze API documentation.

    Create New User Alias

    This endpoint adds new user aliases for existing identified users or creates new unidentified users in your Braze account. Adding a user alias for an existing user requires a valid external_id to be included in the new user alias object. Use this endpoint when you need to create user aliases or link additional identifiers to existing users.

    • The endpoint uses POST requests to {instance_url}/users/alias/new where {instance_url} is your Braze REST instance URL from the credential configuration. The endpoint URL is automatically constructed based on your credential's instance URL configuration.
    • The endpoint sends data from your Nexset as the request body in JSON format. The request body is automatically transformed to include your Nexset records in the user_aliases array. Each record in your Nexset will be included in the batch request body.
    • Batch mode is enabled for this endpoint. Multiple records from your Nexset will be grouped into batch requests, with up to 50 records per batch. This allows efficient processing of multiple user alias creations in a single API call.
    • Ensure your Nexset data includes the required fields for creating user aliases, including the external_id for existing users or alias information for new unidentified users.

    The request body must be properly formatted JSON that matches the Braze API specification for creating user aliases. The request body is automatically transformed to wrap your Nexset records in the user_aliases array structure. The endpoint requires Bearer token authentication in the Authorization header, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is enabled (batch.mode: true) with a maximum of 50 records per batch (max.poll.records: 50), allowing efficient processing of multiple user alias creations. For detailed information about creating user aliases, including required fields and request formats, see the Braze API documentation.

Configure Manually​

Braze destinations can be manually configured to send data to any valid Braze REST API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Braze API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Braze API from the Method pulldown menu. The Braze REST API primarily uses POST requests for data writing operations. The most common methods are:

    • POST: For creating new resources or performing actions (e.g., identifying users, creating aliases)
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

Data Format​

  1. Select the format in which the Nexset data will be sent to the Braze API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. The Braze REST API typically uses JSON format for request bodies.

API Endpoint URL​

  1. Enter the URL of the Braze API endpoint to which you want to send the Nexset data in the URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Braze API endpoints typically follow the pattern {instance_url}/{endpoint_path} where {instance_url} is your Braze REST instance URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires Bearer token authentication in the Authorization header, which is handled automatically by your credential configuration. For detailed information about Braze API endpoints and available APIs, see the Braze API documentation.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers are often required for API versioning, content type specifications, or custom authentication requirements.

    You do not need to include any headers already present in the credentials. Common headers like Authorization (Bearer token), Content-Type, and Accept are typically handled automatically by Nexla based on your credential configuration. The Braze REST API requires Bearer token authentication in the Authorization header, which is handled automatically by your credential configuration. The Content-Type: application/json header is typically set automatically for JSON request bodies.

Request Body​

Optional

  • If the API endpoint requires a specific request body format, configure how Nexla should format the request body from your Nexset data. The request body can be sent as JSON, XML, or form data, depending on the API endpoint requirements.

    • For JSON format, select JSON from the Request Body Format dropdown, and the Nexset data will be sent as a JSON object in the request body. Braze REST API endpoints typically use JSON format for request bodies.

    • For XML format, select XML from the Request Body Format dropdown, and the Nexset data will be converted to XML format in the request body.

    • For Form data format, select Form Data from the Request Body Format dropdown, and the Nexset data will be sent as form-encoded data in the request body.

Save the Destination​

  1. Once all configuration steps have been completed, click the Save button to save your destination configuration.

  2. The destination will now be available in your data flow and will begin sending data to the Braze endpoint according to the configured settings.