Brivo

Brivo is a cloud-based physical access control platform. The Brivo Access API lets you manage and sync users (cardholders), sites, access points, access groups, credentials, and access and audit event logs across your account. Use this connector to bring Brivo access-control data into Nexla, or to provision and update users, credentials, and groups from your Nexla flows.

Power end-to-end data operations for your Brivo API with Nexla. Our bi-directional Brivo connector is purpose-built for Brivo, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Brivo or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Brivo workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Brivo credential, you need OAuth2 application credentials (a Client ID and Client Secret), a refresh token from Brivo's authorization-code flow, and a Mashery API key. The Brivo Access API uses 3-legged OAuth2 against auth.brivo.com to mint access tokens, and every call to api.brivo.com must also carry an api-key header (the Mashery key).

To obtain your Brivo credentials:

1. Register as a developer at developer.brivo.com and request access for your integration. Brivo provisions a sandbox account and, on request, a production API (Mashery) key for your account's environment (PROD or EU).

2. In your Brivo Access account, create an Application under Marketplace > Generate API Token. Note the Client ID and Client Secret issued for the Application.

3. Complete the OAuth2 authorization-code flow against https://auth.brivo.com/oauth/authorize and exchange the resulting code at https://auth.brivo.com/oauth/token (using Basic client_id:client_secret) to obtain a refresh token. Nexla uses this refresh token to mint new access tokens as needed.

4. Obtain your Mashery API key from the Brivo developer portal (developer.brivo.com). This key is sent as the api-key header on every request to api.brivo.com and must match your account's environment.

For full details on authentication and available endpoints, see the Brivo API Documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
Client ID	Yes	No	OAuth2 Client ID for the Application created in your Brivo Access account under Marketplace > Generate API Token.
Client Secret	Yes	Yes	OAuth2 Client Secret paired with the Client ID, used to build the Basic auth signature for token requests to auth.brivo.com.
Refresh Token	Yes	Yes	OAuth2 refresh token obtained after completing the authorization_code flow, used to mint new access tokens from https://auth.brivo.com/oauth/token.
API Key	Yes	Yes	Mashery API key from developer.brivo.com. Sent as the api-key header on every api.brivo.com call; must match the account's environment (PROD or EU).

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your Brivo Client ID, Client Secret, Refresh Token, and API Key in the corresponding fields. These values are obtained in Prerequisites. The Client Secret, Refresh Token, and API Key are sensitive and should be kept confidential.

4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Brivo connector tile, then select the credential that will be used to connect to the Brivo instance, and click Next; or, create a new Brivo credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Brivo endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

Users

List users (cardholders) provisioned in the Brivo account.

Get User

Retrieve a single user by ID.

User Credentials

List credentials (badges/cards/PINs) assigned to a user.

User Access Groups

List access groups a user belongs to.

Sites

List Sites (physical locations/facilities) configured in the account.

Get Site

Retrieve a single Site by ID.

Site Access Points

List Access Points for a Site.

Access Points

List Access Points (doors/entry points), including control panel and site association.

Get Access Point

Retrieve a single Access Point by ID.

Access Groups

List Access Groups configured in the account.

Group Users

List users assigned to an Access Group.

Credentials

List Credentials (cards/badges/PINs) in the account, assigned or unassigned.

Get Credential

Retrieve a single Credential by ID.

Credential Formats

List supported credential formats (e.g. HID 26-bit).

Access Events

List access event log entries (badge swipes, unlock actions) across the account's doors and access points.

Audit Events

List administrative audit event log entries.

Administrators

List portal administrators for the account.

Get Administrator

Retrieve a single Administrator by ID.

Accounts

List accounts accessible to the authenticated application.

Account Summary

Retrieve a summary of the current account.

Schedules

List access schedules configured in the account.

Holidays

List holidays configured for schedule exceptions.

Custom Fields

List custom fields defined for users in the account.

Cameras

List cameras integrated with the account.

Control Panels

List access control panels (hardware controllers) in the account.

Roles

List administrator roles configured in the account.

Event Subscriptions

List webhook event subscriptions configured for the account.

Applications

List OAuth2 applications registered for the account.

User Suspended Status

Query whether a user's access is currently suspended.

Features

List features enabled for the account.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Brivo data sources can also be manually configured to ingest data from any valid Brivo Access API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Brivo data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Brivo destination, and select the Send to Destination option from the menu. Select the Brivo connector from the list of available destination connectors, then select the credential that will be used to connect to the Brivo account, and click Next; or, create a new Brivo credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Brivo endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Create User

Create a new user (cardholder) in the Brivo account.

Update User

Update an existing user's details.

Delete User

Delete a user from the account.

Toggle Suspended Status

Suspend or reinstate a user's access.

Create Credential

Create a new credential (card/badge/PIN).

Delete Credential

Delete a credential from the account.

Assign Credential to User

Assign an existing credential to a user.

Remove Credential from User

Unassign a credential from a user.

Create Access Group

Create a new Access Group.

Add User to Access Group

Add a user to an Access Group.

Manual configuration

Brivo destinations can also be manually configured to send data to any valid Brivo Access API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Brivo endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Brivo endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.