Branch
Platform Summary
Branch Events API and event tracking contracts.
Scope
Primary execution surface: hybrid.
Developer Source Map
| Source | Reason |
|---|---|
| Branch Event Ontology | Event Contracts |
| Branch Events API | Transport / Payload Rules; events, payload, transport |
| Branch Log Custom Events Reference | Event Contracts; events, payload fields, requirements |
| Track Branch Events | Event Contracts; Transport / Payload Rules; User Data Contracts; event names, custom_data, event_data |
RudderStack Cross-Check
RudderStack is used here only as secondary engineering evidence for discovery and cross-check.
| Destination | Type | Link |
|---|---|---|
branch | Discovery lead | source |
Verified Contracts
Event Contracts
| Object / Event | Field | Applies To | Type | Requirement | Exact Format | Normalization | Hashing | Examples | Caveat | Primary Source | Status | Confidence |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
event | branch_key | server | string | Required | Branch app key used to authenticate event requests. | Not clearly specified | Not clearly specified | - | Required field in Branch log custom events API payload. | Branch Log Custom Events Reference | Verified | High |
event | event_data | hybrid | object | Optional | Event payload object with event-specific attributes (for example revenue, currency, transaction_id). | Not clearly specified | Not clearly specified | - | Event payload object in Branch custom/standard event examples. | Track Branch Events | Verified | Medium |
event | name | server | string | Required | Event name. Use Branch standard event names for standard events or custom event name for custom events. | Not clearly specified | Not clearly specified | - | Branch Event Ontology defines standard event names for Web/API surface. | Branch Event Ontology | Verified | Medium |
User Data Contracts
| Object / Event | Field | Applies To | Type | Requirement | Exact Format | Normalization | Hashing | Examples | Caveat | Primary Source | Status | Confidence |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
event | browser_fingerprint_id | hybrid | string | Conditional | Browser fingerprint identifier used for matching when sending web + API events. | Not clearly specified | Not clearly specified | - | Branch docs describe including developer_identity or browser_fingerprint_id for matching in web/API flows. | Track Branch Events | Verified | Medium |
event | custom_data | hybrid | object | Optional | Custom key-value object attached to the event. | Not clearly specified | Not clearly specified | - | Custom attributes supported for Branch event tracking payloads. | Track Branch Events | Verified | Medium |
event | developer_identity | hybrid | string | Conditional | Identifier used for matching when sending web + API events. | Not clearly specified | Not clearly specified | - | Branch docs describe including developer_identity or browser_fingerprint_id for matching in web/API flows. | Track Branch Events | Verified | Medium |
Transport / Payload Rules
| Object / Event | Field | Applies To | Type | Requirement | Exact Format | Normalization | Hashing | Examples | Caveat | Primary Source | Status | Confidence |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
request | POST /v2/event/custom | server | string | Required | HTTPS endpoint for logging custom Branch events. | Not clearly specified | Not applicable | - | Branch Events API endpoint. | Branch Events API | Verified | High |
request | POST /v2/event/standard | server | string | Required | HTTPS endpoint for logging standard Branch events. | Not clearly specified | Not applicable | - | Branch Events API endpoint. | Branch Events API | Verified | High |
request | X-IP-Override | server | string | Conditional | Header containing user IP for server-to-server web + API event requests. | Not clearly specified | Not clearly specified | - | Branch docs describe sending user IP in X-IP-Override header for web + API event processing. | Track Branch Events | Verified | Medium |
Candidate / Needs Review Items
No candidate rows currently tracked.
Excluded Items
No excluded rows in this revision.
Last Reviewed
2026-03-30