Connect Envoy with API Key – StackOne Hub

Link a Envoy account in the StackOne Hub using API Key. End-user guide to authorize the integration and start using Envoy actions.

Creating an integration in the Envoy Dev Dashboard requires an Envoy account with developer access. The Client API Key is shown only after you save the integration — copy it before leaving the page.

Create an integration in the Dev Dashboard

The Envoy Client API Key is a long-lived token generated for an integration in the Envoy Dev Dashboard. Create the integration, then copy the key into StackOne Hub.

1. Open the Dev Dashboard

   Sign in to the Envoy dashboard. In the left sidebar, expand Integrations and click Dev dashboard to open the My Integrations page, then click Create New in the top-right corner.

   
2. Enter the integration details

   On the Create Integration screen, under Details, type a recognisable name in the Name field (for example, StackOne). The other fields — Category, Description, Logo URL — are optional.

   
3. Add the API scopes

   Enables actions: Cancel Reservation, Check In Invite, Check In Reservation, Check In Work Schedule, Check Out Reservation, Check Out Work Schedule, Create Blocklist Entry, Create Desk, Create Invite, Create Recurring Invite, Create Reservation, Create Work Schedule, Delete Blocklist Entry, Delete Desk, Delete Invite, Delete Work Schedule, Get Blocklist Entry, Get Company, Get Desk, Get Employee, Get Entry, Get Flow, Get Invite, Get Location, Get Recurring Invite, Get Reservation, Get Space, Get Unified Credentials, Get Unified Group, Get Unified Organization, Get Unified User, Get Work Schedule, List Blocklist Entries, List Desks, List Employees, List Entries, List Flows, List Invites, List Locations, List Reservations, List Spaces, List Unified Groups, List Unified Organizations, List Unified Users, List Work Schedules, Update Blocklist Entry, Update Desk, Update Invite, Update Recurring Invite

   Open the API Scopes dropdown and select every scope the integration needs. These scopes control what data the Client API Key can access — add all of the scopes below so every StackOne action works.

   

   • companies.read⧉
   • flows.read⧉
   • entries.read⧉
   • entries.write⧉
   • invites.read⧉
   • invites.write⧉
   • blacklist-filters.read⧉
   • blacklist-filters.write⧉
   • locations.read⧉
   • employees.read⧉
   • work-schedules.read⧉
   • work-schedules.write⧉
   • spaces.read⧉
   • spaces.write⧉
   • reservations.read⧉
   • reservations.write⧉
4. Save the integration

   Tick Yes, display on the integrations page, then click Save. Envoy generates the credentials only after the first save.

   

Copy the Client API Key

After saving, the Envoy API Credentials section appears with the long-lived key.

1. Copy the Client API Key into StackOne Hub

   In the Envoy API Credentials section, copy the Client API Key value and paste it into the Client API Key field in StackOne Hub.

   • Client API Key — a long-lived token sent on every request. Treat it like a password and store it securely; it is shown here so you can copy it before leaving the page.

   

Linking the Account from the Hub

1. Navigate to the Hub

   Use one of the three Linking Account Methods to access the Hub.

2. Fill out the fields

   Fill out the following fields using details from your provider:

   • Client API Key
3. Connect

   • Click Connect
   • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
   • Once authorization is successful, you will see a confirmation popup

If the account linking is successful, you will see the newly linked account in your Accounts page.