Skip to main content

​
About Brivo

Brivo Access is a cloud physical-access platform for cardholders, credentials, sites, and access groups. The Serval Brivo integration is in Beta. Each connection maps to one Brivo account in either the US (access.brivo.com) or EU (access.eu.brivo.com) environment. Authentication: Customer-provided OAuth 2.0 application plus a Mashery API key. You create the application in Brivo Marketplace (authorization_code and refresh_token grants), paste the Client ID, Client Secret, and API key into Serval, and approve access in Brivo. Serval refreshes access tokens automatically. Brivo access tokens expire after five minutes, so refresh is required on nearly every call. Data sync: On-demand only. Workflows call the Brivo Access API when they run. Four health checks verify accounts, users, access groups, and sites.

​
What the Brivo integration enables

Anything defined in the Brivo Access API can be reached through the generic request action. Auth headers are injected by Serval; do not put the API key or bearer token in workflow code.

​
Get your credentials

1

Create a Marketplace application in Brivo Access

In Brivo Access (or access.eu.brivo.com for EU accounts), open Marketplace and choose Generate API Token. Name the application, select the 3-legged / authorization_code grant, and enable the refresh_token grant. Password grant cannot be combined with authorization_code.
2

Set the redirect URI

Add this redirect URI to the application: https://svflow-auth-config.api.serval.com/brivo/oauth/callbackSelf-hosted Serval deployments use https://svflow-auth-config.api.<your-domain>/brivo/oauth/callback instead. The connect dialog also shows the exact URI for your environment.
3

Copy the Client ID and Client Secret

Open the enabled application in Marketplace and copy both values.
4

Copy a Mashery API key

From developer.brivo.com, copy an API key for the same environment as the account (PROD vs EU). A Developer Inactive response usually means the key is missing, wrong, or for the other environment. Production keys are issued by Brivo; developer keys are capped at 25,000 calls per month.
Treat the Client Secret and API key like passwords. Serval stores them to refresh tokens and to sign API calls, and only shows obfuscated values later.

​
Connect in Serval

1

Open the Brivo connect form

Find Brivo in the Serval app catalog (it is labeled Beta) and start the connection.
2

Choose US or EU

Match the Brivo account: US uses auth.brivo.com and api.brivo.com; EU uses auth.eu.brivo.com and api.eu.brivo.com.
3

Paste Client ID, Client Secret, and API key

All three fields are required. Register the displayed redirect URI on the Brivo application before connecting.
4

Authorize in Brivo

Serval redirects to Brivo to sign in and approve access. Finish within 10 minutes of clicking Connect.
Brivo connections cannot be edited in place. To rotate the Client Secret or API key, reconnect and re-enter the values.

​
Verifying the connection

​
Gotchas and troubleshooting

Brivo requires grant_type=refresh_token with Basic client credentials and the api-key header on auth.brivo.com. Custom integrations only offer API key, OAuth client credentials, or delegated OIDC, and cannot store a refresh token together with client credentials. Use this native integration instead.
The Mashery api-key header is missing or does not match the environment. Confirm the key from developer.brivo.com is for US or EU, matching the environment selected at connect time.
The Marketplace application must include the refresh_token grant. Create a new application with authorization_code and refresh_token, then reconnect.
Credentials entered in the connect dialog are held for 10 minutes. Start the flow again and finish Brivo approval promptly.
Need help? Contact support@serval.com for assistance with your Brivo integration.