Envoy

Version 0.0.3

📘

Check out the API docs here for more information.

Set up


To get set up with Envoy you will need to get the API Key from your Envoy app. There is information on the steps needed to retrieve this on the API docs here

For the purpose of avoiding permissions issues, please make sure you have added the scopes:

You can use the API Key to get set up with Envoy in the Kleene app when you are creating a new Source.

Features


FeatureSupportNotes
Backfill✅Custom backfill (between 1 week and 6 months) for Reservations, Entries, Invites; All time for all other reports
Incremental❌N/A
API reliability🟢Reliable

Reports detail


⬇️ Report🔑 Incremental key🔑 Primary key📄 Link to API endpoint
LocationsN/AIDLocations
EmployeesN/AIDEmployees
FlowsN/AIDFlows
EntriesN/AIDEntries
InvitesN/AIDInvites
Work SchedulesN/AIDWork Schedules
ReservationsN/AIDReservations
SpacesN/AIDSpaces
DesksN/AIDDesks

🚧

Time standard in responses is UTC

E.G. please note that the API returns values for 'START_TIME' and 'END_TIME' fields of Reservations in UTC standard.

You may want to deal with this in a Transform if you need this adjusted to a different time zone.

Reservations will have data on a locationId for the location they are linked to in the 'SPACE' field. The Locations will have data on their timezone in the 'TIMEZONE' field.

📘

Spaces API in Beta

As you may see in the API docs here the Spaces API is currently in Beta. It covers the Reservations, Spaces and Desks endpoints. The developers have stated they will make an effort to maintain backward-compatibility, however, they have also advised they reserve the right to make incompatible changes when necessary.