### Connect to Your Braze Account
1. Select the Braze integration on the [Partners](https://my.extole.com/partners) page of your My Extole account.
2. Within the Braze integration, hit the Install button to initiate the connection between Extole and Braze.
3. Fill out the required fields, starting with the Braze REST API key. Create it in your Braze account under **Settings** > **REST API Key** > **Create New API Key**, and select both the `users.track` and `campaigns.trigger.send` options. Extole uses `users.track` to record events and attributes and `campaigns.trigger.send` to trigger campaigns and Canvases, so a key with only the first authorizes half the integration. Select both at creation: Braze does not let you add a permission to an existing key.
4. Enter your Braze API URL. This URL depends on which instance your Braze account is provisioned to. You can find it [in Braze's API documentation](https://www.braze.com/docs/api/basics/#endpoints).
5. Add any additional Extole events you'd like to send to Braze beyond the defaults. The default events, event properties, and user attributes are described in the [Extole Events table](https://docs.extole.com/docs/braze#extole-program-events) below.
6. Add any additional Reward states you'd like to send to Braze beyond the default `FULFILLED` state. Refer to the [Extole Rewards table](https://docs.extole.com/docs/braze#extole-rewards) below for a description of all available reward states.
7. Select your Braze External ID key mapping, which is how Extole updates user profiles in Braze. You can map the Braze External ID key to Extole's`email_address`or `partner_user_id`for the user.
8. Complete the connection by saving your settings. Once this is done, Extole events will be able to flow into your Braze account.
### Extole Program Events
Below are the default events, event properties, and user attributes Extole will send into Braze. In addition to the default events listed here, you can add any other Extole events to your integration. Please work with your Extole Implementation or Customer Success Manager to identify and add any additional events you would like to send to Braze.
| Event Name | Event Definition | Event Properties | User Attributes |
|---|---|---|---|
| `extole_share_link_created` | A participant creates their share link by entering their email in the Extole Share Experience. | Email\ Funnel (advocate or friend)\ Program | Email\ External ID\ Share link |
| `extole_shared` | A participant shares their referral link with a friend. | Email\ Funnel (advocate or friend)\ Program\ Share channel | Email\ First name\ Last name |
| `extole_outcome` - The outcome is dynamic based on the configuration of your program (e.g., `extole_shipped`, `extole_converted`, etc.) | A participant has converted or completed the desired outcome event configured for the program. | Dynamic per program | Email\ First name\ Last name |
| State | Definition | Data | User Attributes |
|---|---|---|---|
| `subscribed` | A participant has opted-in to receive marketing messages. | NA | Email\ List type\ External ID\ Email subscribe (opted in) |
| `unsubscribed` | A participant has opted-out of receiving Extole email communications. | Email\ External ID\ Subscription state (unsubscribed)\ Subscription group ID | List type |
| Reward State (Event Name) | Definition | Event Properties | User Attributes |
|---|---|---|---|
| `FULFILLED` - Default | The reward has been assigned a value (e.g., coupon, gift card, etc.) by an Extole reward supplier. | Email\ Face value\ Coupon code\ Face value type | Email\ First name\ Last name |
| `EARNED` | A reward has been created and associated with a person. | Email\ Face value\ Coupon code\ Face value type | Email\ First name\ Last name |
| `SENT` | The reward has been fulfilled and has been sent either via email or on a device to the recipient. | Email\ Face value\ Coupon code\ Face value type | Email\ First name\ Last name |
| `REDEEMED` | The reward has been used by the recipient, as evidenced in a conversion or redemption event sent to Extole. | Email\ Face value\ Coupon code\ Face value type | Email\ First name\ Last name |
| `FAILED` | An issue has prevented the reward from being issued or sent, requiring attention. | Email\ Face value\ Coupon code\ Face value type | Email\ First name\ Last name |
| `CANCELED` | The reward has been deactivated and will return to inventory. | Email\ Face value\ Face value type | Email\ First name\ Last name |
| `REVOKED` | The fulfilled reward has been invalidated. For example, Extole requested a gift card from a supplier and then subsequently determined that the card was sent in error. If the supplier supports revoking the reward, we would request the funds back and the reward would no longer be valid. | Email\ Face value\ Face value type | Email\ First name\ Last name |
[//]: ___