How do I set up the Envoy Integration?

If you use Envoy for your visitor management system, Openpath can automatically assign access to Envoy visitors. You do this by creating an "Envoy Bot" in the Openpath Control Center that will generate guest access links for visitors in the Envoy system that can be shared by email or SMS.

To set up the Envoy integration:

  1. Go to and log in
  2. Under Users > User Management, click Create User
    • Enter an email
    • Enter a useful First and Last Name (Envoy Bot, for example)
    • Enable Portal Access by clicking the toggle, then adding the Super Admin role (or another role that has the WRITE permission for View and edit users)
    • Click Save
    • Go to the Access tab and enable access to all required Zones and Entries
  3. After creating the user in Openpath, log in to the Envoy dashboard
    1. Go to Integrations > All integrations
      1. Under Building security, find Openpath, then click Install
      2. In the API step, enter administrative credentials created for the Envoy Bot in Openpath and click Save
      3. On the Org step, select the desired Organization from the drop down and click Next Step to continue
        1. The drop down menu on this step is automatically populated based on the Orgs the administrative account provided in Step 2 has access to. If you do not see your intended Organization then you must revisit your permissions within Openpath.
      4. On the Entries step, select which entries you want to permit visitor types to access. Click Next Step after you have finalized your entry / visitor type privilege mapping.
        1. This step allows you to select multiple visitor types per entry
        2. This step allows you to add additional entries with the “Add another” button
      5. On the Customization step, you can select several options of customization, including:
        1. ONLY ALLOW INVITED GUESTS: Toggling this setting will switch to “Sign In” only Cloud Credential issuance when disabled, and “Invite” based Cloud Credentials when enabled. When this option is disabled the “ADVANCE ACCESS” and “ACCESS DURATION” fields can not be obeyed.
        2. ADVANCE ACCESS: This is the length of time the Cloud Credential will work before the invited date and time (e.g., An invite may be for 8PM on April 13th, but 15 minutes or even 12 hours prior to the meeting can be added to enable to the Cloud Credentials early, allowing visitors to access the facilities for parking or lodgings).
        3. ACCESS DURATION: This is the length of time the Cloud Credential will work for. After the access duration expires automatically in Envoy the Cloud Credential will cease to work.
        4. FLOW BLOCK LIST (OPTIONAL): This is the list of visitor types which are blocked from receiving access.
        5. YOUR CUSTOM LOGO (OPTIONAL): This is the logo which is displayed to visitors when they unlock doors with their temporary Cloud Credentials.
        6. ADDITIONAL INSTRUCTIONS (OPTIONAL): This is the additional instructions / messaging which is displayed to visitors when they unlock doors with their temporary Cloud Credentials.
    2. For more information, see Envoy's support article

Additional resources

Learn more about Openpath integrations

Learn more about the Envoy integration

Was this article helpful?
2 out of 3 found this helpful



Please sign in to leave a comment.

Have more questions?

Request support