S2 integration

In this article

S2 is the leading developer of complete enterprise physical security solutions, including access control, video surveillance, event monitoring, digital signage, live Internet sourced real-time data and information feeds, mobile applications and cloud-based services.

How does this integration work?

The Envoy + S2 integration allows you to sync Envoy visitor entry data to your S2 activity log. When you configure the integration, you’ll choose if you want to sync data on all visitors, data on visitor that match a blacklist keyword, or data on blacklist visitors denied entry by the blacklist contact.

If you select to sync data related to Envoy’s blacklist feature, you can also trigger an S2 event when blacklist entries sync to your S2 activity log.

If you choose to sync all visitors, People entries will automatically be added to S2’s log, which will allow for more granular data to be attached to the visitor entry (badging, vehicle, extend visitor registration).

Enabling the Envoy + S2 integration

Note: You’ll need to be an admin on your S2 account to complete this integration. Either become an admin or ask your admin for help before completing these steps:

  1. Go to Integrations > All integrations.
  2. Under Building security, find S2 Security NetBox.
  3. Click “Install.”
  4. In the Specify server step, paste or type your S2 URL in the Enter your URL field, and click “Next step.”
    • S2 on premise NetBox must have an accessible public IP for Envoy to connect
    • Note if non standard ports (http:80 & https:443) are used, this must be accounted for in setup
  5. On the Set credentials step, enter your S2 username and password, and click “Next step.”
  6. On the Configure step, you’ll choose which visitor data to sync to the S2 activity log.
    • Locate the Choose which visitor sync to S2 activity log dropdown.
    • Choose if you’d like to sync 1) all visitor entries or 2) based on Envoy’s blacklist.
    • Locate the Choose preferred blacklist detection dropdown.
    • Choose if you’d like 1) to sync Envoy data every time a blacklist keyword is matched or 2) only when the blacklist contact denies an visitor access.
      • If you do not want to set up an event trigger, click “Complete setup,” and that’s it!
    • To set up an event trigger when a blacklist entry syncs to S2, choose your event trigger from the Trigger an event when blacklist entries sync dropdown.

S2 Netbox required configuration

Note: If you are using an on premise NetBox, the following configurations must be followed.

  • In order for events to show up in the activity log, they need to have at least 1 action (Configuration -> Alarms -> Events -> Actions) created for an Event (E.g. Envoy visitor)

  • In order for activity log to function, there should be at least one Network Node. Node does not need to be real (Configuration -> Site Settings -> Network Nodes -> Type: MicroNode)
  • If entries are not manually signed out, they expire in 24-48h depending on the timezone. The entries use local machine time, not GMT time and they are not reported via the API

How Envoy Visitors entries look in S2

In the example below, the company Second Street Labs created an S2 event called Envoy Blacklist Visitor Registered. They configured the integration to sync all visitor entries. Additionally, they want to trigger the new event they created when a blacklist visitor is denied access.

  • Visitor Sophia Fitzroy signed in at 17:28. Her entry appears in the activity log as a record, but there are no additional triggered events.
  • Visitor Grey Ryer signed in at 18:12. His entry appears in the activity log as a record as well, but additionally, the Envoy Blacklist Visitor Registered event was triggered since he was denied access.

How to view People created in S2 through the sign in event

In the example below, the visitor Sarah Smith has signed in with Envoy and is now accessible as a Person in S2.

  • Locate the visitor through Administration -> People Search

Note: If you want to automatically set access levels for visitors through Envoy, you will need to assign “Events” in Access Levels (Configuration -> Access Control -> Access Levels)