How does Brivo work with Envoy?
The Envoy + Brivo integration provides a range of options to manage access for visitors.
For Visitors, access can be granted to your guests with either invites or sign-ins, and Envoy will create user records in Brivo accordingly.
PREREQUISITES
Super Admin permissions are required on your Brivo Access to complete this installation. Please reach out to your IT team or the manager of your Brivo account if you need this access as Envoy can not grant permissions to your personal accounts.
API KEY: you will need an Envoy specific Brivo API key. Please reach out to Brivo about acquiring this API key. Additional purchase from Brivo may be necessary.
Envoy Visitors + Brivo Access: Visitors must fill out the email field in order for records to be stored in Brivo. Make sure that you have the email field required in your sign-in flow for Visitors.
Brivo + Envoy Configuration
Navigate to the App store on the Envoy dashboard and install the Brivo integration.
Step 1: Info
On the first step, authorize the Brivo plug-in the necessary permissions to read and write data on your Envoy company account.
Enter the Brivo API key. As noted above, you should be able to get your API key from developer.brivo.com/apps/mykeys. If you need assistance with this, please reach out to your IT team or Brivo directly to obtain the key. Additional purchase from Brivo may be necessary.
Step 2: API Access
Your Brivo Admin ID is required to connect your Brivo account to Envoy. It can be found in your Super Administrator Brivo account profile. Click on your name in the bottom left corner of the screen and click to copy the Admin ID.
Click Connect Account.
Login to your Brivo account. Make sure to sign-in using Admin ID and Account Password instead of email address and password.
Authorize the API.
Step 3: Visitors + Envoy
Skip over the "workplace" section of the setup to continue with your Visitors settings.
The Envoy + Brivo integration has the option to automatically grant credentials to Visitors when they are either invited or signed into Envoy. The integration creates users in Brivo and assigns them to a Brivo group of your choosing to grant credentials.
Configuration
Only Allow Invited Guests: Only grants access to Visitors that are invited.
Visitor Types: Choose which sign-in flow/visitor type you would like to grant access credentials and the corresponding Brivo group.
Brivo Group: Select the group that was created in Brivo. The drop-down menu allows multiple groups per visitor type, as well as an additional visitor to group mappings with the Add Another button.
Access Duration: Specify the duration invited guests receive access. This is the length of time the Brivo user’s Effective Date will work.
Advance Access: Allow invited guests to receive access before their scheduled arrival. This is the length of time the Brivo user’s Effective Date will last before the invited date and time (e.g., An invite might be for 8 PM on April 13th, but 15 minutes or even 12 hours prior to the meeting can be added to enable to the user early). Select Disabled to opt-out of this feature.
Select a Credential Type: The type of credential to be issued to the Visitor. This is what they will use to access your workplace.
Card
Minimum and Maximum card ranges in addition to Facility Code, are required to issue credentials in a digital QR code format.
These are card ranges are created and added to the user in Brivo. The QR code is generated from the card #. The ranges follow the format that the Brivo side has configured, such as Wiegand 26 bit which gives you a range of 0 to 65,535.
An email will be sent with the QR code and facility code.
Mobile Pass
PIN
Longer Access PIN: If checked, the access pin generated by Envoy will be 7 characters long instead of the default of 4 characters.
License Plate
Faceprint
Blocklist Matches: Visitors matching Blocklist entries will not be granted credentials unless an admin approves their visit.
Sign Out Access: When this checkbox is checked, users will have their permission groups removed from Brivo during sign-out from Envoy.
How Envoy Visitors entries look in Brivo
In the example below, individual visitors are listed. This list can be found in Brivo under the Users > Users menu.
Envoy creates a custom field, “Envoy Email” which is used to create unique users in Brivo and prevent duplication of users. If this field is emptied on a user or removed from the custom fields the app will experience unexpected behavior.
FAQ
For more information on creating groups and users please refer to Brivo's guide starting on Page 70.
Testing Visitors: To test that Brivo is working correctly, create a visitor sign-in in Envoy and check the invite log. You should see Brivo information is populated on the right hand side.
