Subscription note: This article is intended for Brivo Visitor Management, powered by Envoy customers. You must have a Brivo Visitor Management subscription in order to use a Brivo directory sync.

Overview

Automatically sync employees from Brivo access groups to the Envoy employee directory, ensuring visitor kiosks display accurate, up-to-date employee information without manual data entry.

Sync Frequency

The operation triggers hourly at the zero-minute mark. Note: The volume of Brivo API requests per sync operation depends on the following factors:

Number of groups to sync
Number of employees per group: Since Envoy fetches 100 users per page, a group of 350 employees would require 4 separate requests.

Pre Sync Validation

Before any operation (Create, Update, or Delete), a user must pass the following criteria. If validation fails, the record is skipped.

Required Name Fields: User must have both firstName and lastName
Required Work Email: User must have an email with type "work"
- Email is the main key we use to detect users apart from one another. It is highly advised NOT to use the same email for different users
Valid Email Format: Work email must contain "@" character
Optional Work Phone: User is not required to have it, but if available, the work phone will be synced to Envoy

Configuration

Step 1: Info

Step 2: API Access

An Admin ID is required to connect your Brivo account to Envoy. It can be found in your Super Administrator Brivo account profile. Click your name in the bottom-left corner of the screen, then click to copy the Admin ID.

Click Connect Account.
Select the region your Brivo account resides in (US or EU).
Your Brivo API key will automatically populate in the API key field. No need to retrieve an API key from within your Brivo dashboard.
Click ‘Connect’ to log in to your Brivo account.
Make sure to sign in using Admin ID (see above) and Account Password instead of email address and password.
Authorize the API and click Submit.