Integration API quickstart
How data is structured in Brella
1min
Before building your integration, it's important to understand how key data is structured in Brella. This guide will help explain the hierarchy of various entities:
- Organization: All your Brella events live inside a parent “organization”.
- Events: Most of your event content and settings are inside "events" in Brella.
- Invites: A new invite is created whenever a new registration is created, or a ticket is purchased. Invites offer the most complete data related to event attendance.
- Attendees: A new attendee is created whenever a registrant claims an invite and onboards onto the platform. The app adoption rate can vary by event, so attendees are not a good measure of event attendance.
- Speakers: Dedicated speaker profiles that event organizers can control. These can be linked to content timeslots in the schedule, and displayed in the speakers tab. If speakers need to be able to participate in the event, create an invite they can redeem to become an attendee. You can give them special permissions and access to networking using user groups.
- Sponsors:
- Sponsor categories:Brella offers 3 different sponsor categories (small, medium and large) that can be renamed to suit an event. Every sponsor company is assigned to one category.
- Sponsor companies: These are the entities you can manipulate and view via the /sponsors endpoints
- Schedule:
- Content timeslots:These timeslots in the schedule are used to display information related to your various sessions. You can also attach speakers, tags and locations to these timeslots.
- Networking timeslots:These timeslots are used solely for networking purposes. You can attach tags and locations to these timeslots. You can't create these via the API just yet.
- Webhooks:Webhooks proactively deliver different data payloads in real-time based on specific triggers. Our API can create, update and delete webhooks.
Updated 13 Apr 2023
Did this page help you?