API quickstart
A note on external_id fields
1min
Many entities in Brella (eg: invites, speakers, sponsors, timeslots etc.) support a field called external_id
- This field is not visible in the Admin Panel, and is only accessible via the API or CSV imports / exports
- The field supports almost any data passed as a String.
- The most common use-case for this field is to write a 3rd party app's unique identifier to Brella when creating an entity. This allows for a common unique attribute that can be used when updating, finding or deleting the created entity.
- For example, when creating an invite from a 3rd party CRM (eg: Hubspot), you would write the Hubspot contact_id (generated by Hubspot) to the external_id field in the Brella invite. Then, if you need to update the invite later (for example, if the Hubspot contact changes their email, or drops out of the event), you can find the invite by it's external_id, which is also shared by the Hubspot contact (we have an endpoint that supports this) and update it.
Updated 13 Apr 2023
Did this page help you?