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

# Branch.io

> Event tracking helps you understand how a user moves through your app and what actions they are taking along the way. Commerce, Content, and User Lifecycle events can all be tracked this way.

## Supported syncing

| Sync Type | Description | Supported Sync Modes | API Reference |
| - | - | - | - |
| **Events** | Sync data from any source to Branch.io events | Insert | [GitHub docs](https://github.com/BranchMetrics/branch-deep-linking-public-api?tab=readme-ov-file#logging-custom-events) and [Event docs](https://help.branch.io/developers-hub/reference/logstandardevents) |

For more information about sync modes, refer to the [sync modes](https://docs.hightouch.com/syncs/types-and-modes.md#sync-modes) docs.

## Connect to Branch.io

Go to the [**Destinations** overview page](https://app.hightouch.com/destinations?from=docs) and click the **Add destination** button. Select **Branch.io** and click **Continue**. You can then authenticate Hightouch to **Branch.io**.

Enter the following fields into Hightouch:

* **App ID**
* **Branch Key**
* **Branch Secret**

All of these fields can be found by managing the your [Branch.io profile settings](https://help.branch.io/using-branch/docs/profile-settings). The Branch Key and Branch Secret are considered sensitive information.

## Sync configuration

Once you've set up your Branch.io destination and have a [model](https://docs.hightouch.com/getting-started/concepts.md#models) to pull data from, you can set up your sync configuration to begin syncing data. Go to the [**Syncs** overview page](https://app.hightouch.com/syncs?from=docs) and click the **Add sync** button to begin. Then, select the relevant model and the Branch.io destination you want to sync to.

### Syncing events

Sync data from any source to Branch.io events.

> [!WARNING]
>
> To ensure syncs send each event, your event model must use a truly unique [primary key](https://docs.hightouch.com/getting-started/concepts.md#unique-primary-key-requirement). See the [events syncs](https://docs.hightouch.com/syncs/types-and-modes.md#event-syncs) documentation for more information.

#### Field mapping

Hightouch lets you sync event properties via field mapping.

At least one of the following fields must be mapped so that events can be uniquely identified with a user:

* Developer Identity
* Browser Fingerprint ID
* IDFA
* IDFV
* AAID
* Android ID

## Tips and troubleshooting

To see the exact API requests and responses from each sync run, use the [live debugger](https://docs.hightouch.com/syncs/debugger.md). To get notified by Slack, PagerDuty, SMS, or email when a sync fails, set up [sync alerts](https://docs.hightouch.com/syncs/alerting.md). If you run into an issue this page doesn't cover, [contact support](#pylon-chat).