Envoy (Preview)

An Envoy connector that allows you to be able to connect your Envoy account (our REST API endpoints) to any other connectors. An example would be to create bulk invites in Envoy with details from a Microsoft Excel Online spreadsheet.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure Government regions      -   Azure China regions      -   US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)

Contact
Name	Envoy Support Team
URL	https://envoy.help/
Email	hi@envoy.com

Connector Metadata
Publisher	Envoy, Inc.
Website	https://envoy.com/
Privacy policy	https://envoy.com/privacypolicy/
Categories	Business Intelligence;Data

In version 2.0, you can also use Envoy Invite creation as a trigger.

Prerequisites

To use this connector, you'll need an Envoy account with username and password. For triggering functionality, you will also need to install the Envoy Integration "Microsoft Flow."

How to get credentials

To authenticate to Envoy, you'll need your Envoy username and password.

For triggering functionalty, you'll need the Install Token provided to you during Step 2 of the "Microsoft Flow" Integration setup within Envoy.

Known issues and limitations

At this time, the only trigger available is Invite Creation. We expect to add more triggers in the near future.

Creating a connection

The connector supports the following authentication types:

Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
username	securestring	The username for this api	True
password	securestring	The password for this api	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Add blocklist filter	POST request to add a blocklist filter
Create Invites	This is the POST request to create an invite
Get blocklist filters	GET request to retrieve block list filters.
Get company info	Retrieve information around the company (GET)
Get flows	GET request to retrieve information around the flows for your location.
Get invites	GET request to retrieve Invite information based on filtering.
Get list of employees	GET request to retrieve the employees list
Get locations	GET request for retrieving Locations
Get one Entry	GET request to retrieve information about a single Entry.
Get one Invite	GET request to retrieve information about a single Invite.
Update one Invite	PATCH request to update an Invite's information.

Add blocklist filter

Operation ID:

addBlockListFilter

POST request to add a blocklist filter

Parameters

Name	Key	Required	Type	Description
aliases	aliases		array of	aliases
description	description		string	description
emails	emails		array of string	emails
full-name	full-name		string	full-name
keyword	keyword		string	keyword
other-keywords	other-keywords		array of	other-keywords
reason	reason		string	reason
phone-numbers	phone-numbers		array of	phone-numbers
type	type		string	type
id	id		string	id (location)
type	type		string	type

Returns

Name	Path	Type	Description
id	data.id	string	id
type	data.type	string	type
self	data.links.self	string	self
aliases	data.attributes.aliases	array of	aliases
description	data.attributes.description	string	description
emails	data.attributes.emails	array of string	emails
full-name	data.attributes.full-name	string	full-name
keyword	data.attributes.keyword	string	keyword
other-keywords	data.attributes.other-keywords	array of	other-keywords
phone-numbers	data.attributes.phone-numbers	array of	phone-numbers
original	data.attributes.photo.original	string	original
thumb	data.attributes.photo.thumb	string	thumb
reason	data.attributes.reason	string	reason
created-by	data.attributes.created-by	string	created-by
self	data.relationships.location.links.self	string	self
related	data.relationships.location.links.related	string	related
self	data.relationships.user.links.self	string	self
related	data.relationships.user.links.related	string	related

Create Invites

Operation ID:

addInvite

This is the POST request to create an invite

Parameters

Name	Key	Required	Type	Description
Content-Type	Content-Type		string	Content-Type
full-name	full-name		string	full-name
email	email		string	email
inviter-name	inviter-name		string	inviter-name
expected-arrival-time	expected-arrival-time		string	expected-arrival-time
recurring-rule	recurring-rule		string	recurring-rule
rrule-until	rrule-until		string	rrule-until
private-notes	private-notes		string	private-notes
been-here-before	been-here-before		boolean	been-here-before
additional-guests	additional-guests		integer	additional-guests
skip-guest-notification	skip-guest-notification		boolean	skip-guest-notification
agreements-status	agreements-status		string	agreements-status
place-id	place-id		string	place-id
flow-name	flow-name		string	flow-name
group-name	group-name		string	group-name
arrived	arrived		boolean	arrived
approval-status	approval-status		string	approval-status
field	field		string	field
value	value		string	value
type	type		string	type
id	id		string	id (employee)
type	type		string	type
id	id		string	id (location)
type	type		string	type

Returns

Name	Path	Type	Description
id	data.id	string	id
type	data.type	string	type
self	data.links.self	string	self
additional-guests	data.attributes.additional-guests	integer	additional-guests
status	data.attributes.approval-status.status	string	status
auto_approved	data.attributes.approval-status.auto_approved	boolean	auto_approved
report	data.attributes.approval-status.report	array of object	report
result	data.attributes.approval-status.report.result	string	result
source	data.attributes.approval-status.report.source	string	source
blacklistReportUUID	data.attributes.approval-status.report.blacklistReportUUID	string	blacklistReportUUID
reason	data.attributes.approval-status.report.reason	string	reason
text	data.attributes.approval-status.report.messages.failure.text	string	text
header	data.attributes.approval-status.report.messages.failure.header	string	header
reviewer_id	data.attributes.approval-status.reviewer_id	string	reviewer_id
reviewer_name	data.attributes.approval-status.reviewer_name	string	reviewer_name
review_note	data.attributes.approval-status.review_note	string	review_note
reviewed_at	data.attributes.approval-status.reviewed_at	string	reviewed_at
email	data.attributes.email	string	email
expected-arrival-time	data.attributes.expected-arrival-time	string	expected-arrival-time
expected-departure-time	data.attributes.expected-departure-time	string	expected-departure-time
full-name	data.attributes.full-name	string	full-name
guest-updated-at	data.attributes.guest-updated-at	string	guest-updated-at
is-presigned	data.attributes.is-presigned	boolean	is-presigned
address	data.attributes.location-info.address	string	address
id	data.attributes.location-info.id	integer	id
name	data.attributes.location-info.name	string	name
logo_url	data.attributes.location-info.logo_url	string	logo_url
private-notes	data.attributes.private-notes	string	private-notes
user-data	data.attributes.user-data	array of object	user-data
	data.attributes.user-data.field	string	field
	data.attributes.user-data.value	string	value
notify-visitor	data.attributes.notify-visitor	boolean	notify-visitor
created-from	data.attributes.created-from	string	created-from
arrived	data.attributes.arrived	boolean	arrived
touchless-sign-in-available-time	data.attributes.touchless-sign-in-available-time	string	touchless-sign-in-available-time
touchless-sign-in-presence-required	data.attributes.touchless-sign-in-presence-required	boolean	touchless-sign-in-presence-required
entry-signed-out-at	data.attributes.entry-signed-out-at	string	entry-signed-out-at
preregistration-link	data.attributes.preregistration-link	string	preregistration-link
created-at	data.attributes.created-at	string	created-at
updated-at	data.attributes.updated-at	string	updated-at
self	data.relationships.attendee.links.self	string	self
related	data.relationships.attendee.links.related	string	related
self	data.relationships.creator.links.self	string	self
related	data.relationships.creator.links.related	string	related
self	data.relationships.employee.links.self	string	self
related	data.relationships.employee.links.related	string	related
type	data.relationships.employee.data.type	string	type
id	data.relationships.employee.data.id	string	id
self	data.relationships.entry.links.self	string	self
related	data.relationships.entry.links.related	string	related
type	data.relationships.entry.data.type	object	type
id	data.relationships.entry.data.id	string	id
self	data.relationships.flow.links.self	string	self
related	data.relationships.flow.links.related	string	related
type	data.relationships.flow.data.type	string	type
id	data.relationships.flow.data.id	string	id
self	data.relationships.location.links.self	string	self
related	data.relationships.location.links.related	string	related
type	data.relationships.location.data.type	string	type
id	data.relationships.location.data.id	string	id
self	data.relationships.platform-jobs.links.self	string	self
related	data.relationships.platform-jobs.links.related	string	related

Get blocklist filters

Operation ID:

getblockListFilters

GET request to retrieve block list filters.

Parameters

Name	Key	Required	Type	Description
filter[company]	filter[company]		integer	filter[company]
Content-Type	Content-Type		string	Content-Type

Returns

Name	Path	Type	Description
data	data	array of object	data
id	data.id	string	id
type	data.type	string	type
self	data.links.self	string	self
aliases	data.attributes.aliases	array of	aliases
description	data.attributes.description	string	description
emails	data.attributes.emails	array of string	emails
full-name	data.attributes.full-name	string	full-name
keyword	data.attributes.keyword	string	keyword
other-keywords	data.attributes.other-keywords	array of string	other-keywords
phone-numbers	data.attributes.phone-numbers	array of	phone-numbers
original	data.attributes.photo.original	string	original
thumb	data.attributes.photo.thumb	string	thumb
reason	data.attributes.reason	string	reason
image-url	data.attributes.image-url	string	image-url
external-id	data.attributes.external-id	string	external-id
created-by	data.attributes.created-by	string	created-by
self	data.relationships.location.links.self	string	self
related	data.relationships.location.links.related	string	related
self	data.relationships.user.links.self	string	self
related	data.relationships.user.links.related	string	related
total	meta.total	integer	total

Get company info

Operation ID:

getCompanyInfo

Retrieve information around the company (GET)

Parameters

Name	Key	Required	Type	Description
Accept	Accept		string	Accept

Returns

Name	Path	Type	Description
total	meta.total	integer	total
limit	meta.limit	integer	limit
offset	meta.offset	integer	offset
data	data	array of object	data
id	data.id	string	id
type	data.type	string	type
name	data.attributes.name	string	name
plan-intent	data.attributes.plan-intent	string	plan-intent
buy-intent	data.attributes.buy-intent	boolean	buy-intent
call-enabled	data.attributes.call-enabled	boolean	call-enabled
appletv-enabled	data.attributes.appletv-enabled	boolean	appletv-enabled
saml-connected	data.attributes.saml-connected	boolean	saml-connected
active	data.attributes.active	boolean	active
employees-sync-state	data.attributes.employees-sync-state	string	employees-sync-state
employees-sync-provider	data.attributes.employees-sync-provider	string	employees-sync-provider
employees-last-sync-at	data.attributes.employees-last-sync-at	string	employees-last-sync-at
created-at	data.attributes.created-at	string	created-at
updated-at	data.attributes.updated-at	string	updated-at
onboarding-status	data.attributes.onboarding-status	string	onboarding-status
onboarding-locations-count	data.attributes.onboarding-locations-count	string	onboarding-locations-count
is-beta	data.attributes.is-beta	boolean	is-beta
adhoc-plugins	data.attributes.adhoc-plugins	array of	adhoc-plugins
cached-locations-quantity	data.attributes.cached-locations-quantity	integer	cached-locations-quantity
type	data.relationships.subscription.data.type	string	type
id	data.relationships.subscription.data.id	string	id
type	data.relationships.deliveries-subscription.data.type	string	type
id	data.relationships.deliveries-subscription.data.id	string	id
data	data.relationships.contracts.data	array of object	data
type	data.relationships.contracts.data.type	string	type
id	data.relationships.contracts.data.id	string	id
data	data.relationships.administrators.data	array of object	data
type	data.relationships.administrators.data.type	string	type
id	data.relationships.administrators.data.id	string	id
data	data.relationships.locations.data	array of object	data
type	data.relationships.locations.data.type	string	type
id	data.relationships.locations.data.id	string	id
type	data.relationships.saml.data.type	string	type
id	data.relationships.saml.data.id	string	id
self	links.self	string	self
first	links.first	string	first
last	links.last	string	last

Get flows

Operation ID:

getFlowsInfo

GET request to retrieve information around the flows for your location.

Parameters

Name	Key	Required	Type	Description
filter[location]	filter[location]		integer	filter[location]

Returns

Name	Path	Type	Description
data	data	array of object	data
id	data.id	string	id
type	data.type	string	type
self	data.links.self	string	self
additional-guests	data.attributes.additional-guests	boolean	additional-guests
auto-sign-out-minutes	data.attributes.auto-sign-out-minutes	string	auto-sign-out-minutes
auto-sign-out-at-midnight	data.attributes.auto-sign-out-at-midnight	boolean	auto-sign-out-at-midnight
badge-enabled	data.attributes.badge-enabled	boolean	badge-enabled
enabled	data.attributes.enabled	boolean	enabled
id-check	data.attributes.id-check	boolean	id-check
ipad-localized-names	data.attributes.ipad-localized-names	array of object	ipad-localized-names
language-code	data.attributes.ipad-localized-names.language-code	string	language-code
region-code	data.attributes.ipad-localized-names.region-code	string	region-code
display-name	data.attributes.ipad-localized-names.display-name	string	display-name
name	data.attributes.name	string	name
position	data.attributes.position	integer	position
use-existing-photo	data.attributes.use-existing-photo	boolean	use-existing-photo
created-at	data.attributes.created-at	string	created-at
updated-at	data.attributes.updated-at	string	updated-at
self	data.relationships.agreement-page.links.self	string	self
related	data.relationships.agreement-page.links.related	string	related
self	data.relationships.badge.links.self	string	self
related	data.relationships.badge.links.related	string	related
self	data.relationships.location.links.self	string	self
related	data.relationships.location.links.related	string	related
self	data.relationships.photo-page.links.self	string	self
related	data.relationships.photo-page.links.related	string	related
self	data.relationships.sign-in-field-page.links.self	string	self
related	data.relationships.sign-in-field-page.links.related	string	related
self	data.relationships.summary-page.links.self	string	self
related	data.relationships.summary-page.links.related	string	related
total	meta.total	integer	total
first	links.first	string	first
last	links.last	string	last

Get invites

Operation ID:

getInviteInfo

GET request to retrieve Invite information based on filtering.

Parameters

Name	Key	Required	Type	Description
filter[location]	filter[location]		integer	filter[location]
filter[date]	filter[date]		string	filter[date]
Accept	Accept		string	Accept

Returns

Name	Path	Type	Description
data	data	array of object	data
id	data.id	string	id
type	data.type	string	type
self	data.links.self	string	self
additional-guests	data.attributes.additional-guests	integer	additional-guests
status	data.attributes.approval-status.status	string	status
auto_approved	data.attributes.approval-status.auto_approved	boolean	auto_approved
report	data.attributes.approval-status.report	array of object	report
result	data.attributes.approval-status.report.result	string	result
source	data.attributes.approval-status.report.source	string	source
blacklistReportUUID	data.attributes.approval-status.report.blacklistReportUUID	string	blacklistReportUUID
reason	data.attributes.approval-status.report.reason	string	reason
text	data.attributes.approval-status.report.messages.failure.text	string	text
header	data.attributes.approval-status.report.messages.failure.header	string	header
reviewer_id	data.attributes.approval-status.reviewer_id	string	reviewer_id
reviewer_name	data.attributes.approval-status.reviewer_name	string	reviewer_name
review_note	data.attributes.approval-status.review_note	string	review_note
reviewed_at	data.attributes.approval-status.reviewed_at	string	reviewed_at
email	data.attributes.email	string	email
expected-arrival-time	data.attributes.expected-arrival-time	string	expected-arrival-time
expected-departure-time	data.attributes.expected-departure-time	string	expected-departure-time
full-name	data.attributes.full-name	string	full-name
guest-updated-at	data.attributes.guest-updated-at	string	guest-updated-at
is-presigned	data.attributes.is-presigned	boolean	is-presigned
address	data.attributes.location-info.address	string	address
id	data.attributes.location-info.id	integer	id
name	data.attributes.location-info.name	string	name
logo_url	data.attributes.location-info.logo_url	string	logo_url
company_name	data.attributes.location-info.company_name	string	company_name
timezone	data.attributes.location-info.timezone	string	timezone
private-notes	data.attributes.private-notes	string	private-notes
user-data	data.attributes.user-data	array of object	user-data
field	data.attributes.user-data.field	string	field
value	data.attributes.user-data.value	string	value
notify-visitor	data.attributes.notify-visitor	boolean	notify-visitor
created-from	data.attributes.created-from	string	created-from
place_id	data.attributes.locality.place_id	string	place_id
place-id	data.attributes.locality.place-id	string	place-id
arrived	data.attributes.arrived	boolean	arrived
touchless-sign-in-available-time	data.attributes.touchless-sign-in-available-time	string	touchless-sign-in-available-time
touchless-sign-in-presence-required	data.attributes.touchless-sign-in-presence-required	boolean	touchless-sign-in-presence-required
entry-signed-out-at	data.attributes.entry-signed-out-at	string	entry-signed-out-at
attested	data.attributes.attested	string	attested
phone	data.attributes.phone	string	phone
preregistration-link	data.attributes.preregistration-link	string	preregistration-link
preregistration-status-link	data.attributes.preregistration-status-link	string	preregistration-status-link
reminder-sent-at	data.attributes.reminder-sent-at	string	reminder-sent-at
created-at	data.attributes.created-at	string	created-at
updated-at	data.attributes.updated-at	string	updated-at
self	data.relationships.attendee.links.self	string	self
related	data.relationships.attendee.links.related	string	related
self	data.relationships.creator.links.self	string	self
related	data.relationships.creator.links.related	string	related
self	data.relationships.employee.links.self	string	self
related	data.relationships.employee.links.related	string	related
type	data.relationships.employee.data.type	string	type
id	data.relationships.employee.data.id	string	id
self	data.relationships.entry.links.self	string	self
related	data.relationships.entry.links.related	string	related
type	data.relationships.entry.data.type	string	type
id	data.relationships.entry.data.id	string	id
self	data.relationships.flow.links.self	string	self
related	data.relationships.flow.links.related	string	related
type	data.relationships.flow.data.type	string	type
id	data.relationships.flow.data.id	string	id
self	data.relationships.location.links.self	string	self
related	data.relationships.location.links.related	string	related
type	data.relationships.location.data.type	string	type
id	data.relationships.location.data.id	string	id
self	data.relationships.platform-jobs.links.self	string	self
related	data.relationships.platform-jobs.links.related	string	related
total	meta.total	integer	total
first	links.first	string	first
next	links.next	string	next
last	links.last	string	last

Get list of employees

Operation ID:

getEmployee

GET request to retrieve the employees list

Returns

Name	Path	Type	Description
data	data	array of object	data
id	data.id	string	id
type	data.type	string	type
self	data.links.self	string	self
cc-employee	data.attributes.cc-employee	boolean	cc-employee
company-id	data.attributes.company-id	integer	company-id
deleted	data.attributes.deleted	boolean	deleted
do-not-sync	data.attributes.do-not-sync	boolean	do-not-sync
email	data.attributes.email	string	email
hide-from-host-list	data.attributes.hide-from-host-list	boolean	hide-from-host-list
manually-added	data.attributes.manually-added	boolean	manually-added
manually-added-location-present	data.attributes.manually-added-location-present	boolean	manually-added-location-present
name	data.attributes.name	string	name
phone-number	data.attributes.phone-number	string	phone-number
created-at	data.attributes.created-at	string	created-at
deleted-at	data.attributes.deleted-at	string	deleted-at
updated-at	data.attributes.updated-at	string	updated-at
self	data.relationships.company.links.self	string	self
related	data.relationships.company.links.related	string	related
self	data.relationships.user.links.self	string	self
related	data.relationships.user.links.related	string	related
self	data.relationships.assistants.links.self	string	self
related	data.relationships.assistants.links.related	string	related
self	data.relationships.bosses.links.self	string	self
related	data.relationships.bosses.links.related	string	related
self	data.relationships.employee-locations.links.self	string	self
related	data.relationships.employee-locations.links.related	string	related
self	data.relationships.locations.links.self	string	self
related	data.relationships.locations.links.related	string	related
total	meta.total	integer	total
first	links.first	string	first
last	links.last	string	last

Get locations

Operation ID:

getLocationInfo

GET request for retrieving Locations

Parameters

Name	Key	Required	Type	Description
Accept	Accept		string	Accept

Returns

Name	Path	Type	Description
data	data	array of object	data
id	data.id	string	id
type	data.type	string	type
self	data.links.self	string	self
address	data.attributes.address	string	address
address-line-one	data.attributes.address-line-one	string	address-line-one
address-line-two	data.attributes.address-line-two	string	address-line-two
auto-sign-out-at-midnight	data.attributes.auto-sign-out-at-midnight	boolean	auto-sign-out-at-midnight
auto-sign-out-minutes	data.attributes.auto-sign-out-minutes	string	auto-sign-out-minutes
city	data.attributes.city	string	city
company-name-override	data.attributes.company-name-override	string	company-name-override
disabled	data.attributes.disabled	boolean	disabled
employees-csv-upload-status	data.attributes.employees-csv-upload-status	string	employees-csv-upload-status
employees-sync-message	data.attributes.employees-sync-message	string	employees-sync-message
fallback-notifications-enabled	data.attributes.fallback-notifications-enabled	boolean	fallback-notifications-enabled
pre-registration-required-enabled	data.attributes.pre-registration-required-enabled	boolean	pre-registration-required-enabled
latitude	data.attributes.latitude	float	latitude
locale	data.attributes.locale	string	locale
logo-small-url	data.attributes.logo-small-url	string	logo-small-url
logo-thumb-url	data.attributes.logo-thumb-url	string	logo-thumb-url
logo-url	data.attributes.logo-url	string	logo-url
longitude	data.attributes.longitude	float	longitude
name	data.attributes.name	string	name
printer-notifications-enabled	data.attributes.printer-notifications-enabled	boolean	printer-notifications-enabled
multiple-languages-enabled	data.attributes.multiple-languages-enabled	boolean	multiple-languages-enabled
enabled-locales	data.attributes.enabled-locales	array of	enabled-locales
state	data.attributes.state	string	state
timezone	data.attributes.timezone	string	timezone
zip	data.attributes.zip	string	zip
average-monthly-visitors	data.attributes.average-monthly-visitors	float	average-monthly-visitors
created-at	data.attributes.created-at	string	created-at
last-entry-at	data.attributes.last-entry-at	string	last-entry-at
updated-at	data.attributes.updated-at	string	updated-at
self	data.relationships.company.links.self	string	self
related	data.relationships.company.links.related	string	related
self	data.relationships.device-config.links.self	string	self
related	data.relationships.device-config.links.related	string	related
self	data.relationships.gdpr-configuration.links.self	string	self
related	data.relationships.gdpr-configuration.links.related	string	related
self	data.relationships.printer.links.self	string	self
related	data.relationships.printer.links.related	string	related
self	data.relationships.devices.links.self	string	self
related	data.relationships.devices.links.related	string	related
self	data.relationships.employees.links.self	string	self
related	data.relationships.employees.links.related	string	related
self	data.relationships.fallback-contacts.links.self	string	self
related	data.relationships.fallback-contacts.links.related	string	related
self	data.relationships.flows.links.self	string	self
related	data.relationships.flows.links.related	string	related
self	data.relationships.locations-setup-guide-steps.links.self	string	self
related	data.relationships.locations-setup-guide-steps.links.related	string	related
self	data.relationships.printers.links.self	string	self
related	data.relationships.printers.links.related	string	related
self	data.relationships.printer-contacts.links.self	string	self
related	data.relationships.printer-contacts.links.related	string	related
total	meta.total	integer	total
first	links.first	string	first
last	links.last	string	last

Get one Entry

Operation ID:

getEntryInfoByID

GET request to retrieve information about a single Entry.

Parameters

Name	Key	Required	Type	Description
entry_id	entry_id	True	string	entry_id
filter[location]	filter[location]		integer	filter[location]
Accept	Accept		string	Accept

Returns

Name	Path	Type	Description
id	data.id	string	id
type	data.type	string	type
full-name	data.attributes.full-name	string	full-name
email	data.attributes.email	string	email
host	data.attributes.host	string	host
host-email	data.attributes.host-email	string	host-email
private-notes	data.attributes.private-notes	string	private-notes
signed-in-at	data.attributes.signed-in-at	string	signed-in-at
device-session-uuid	data.attributes.device-session-uuid	string	device-session-uuid
signed-in-via	data.attributes.signed-in-via	string	signed-in-via
signed-in-by	data.attributes.signed-in-by	string	signed-in-by
signed-out-via	data.attributes.signed-out-via	string	signed-out-via
signed-out-by	data.attributes.signed-out-by	string	signed-out-by
large	data.attributes.thumbnails.large	string	large
small	data.attributes.thumbnails.small	string	small
flow-name	data.attributes.flow-name	string	flow-name
original-nda-sign-date	data.attributes.original-nda-sign-date	string	original-nda-sign-date
id-check-status	data.attributes.id-check-status	string	id-check-status
is-delivery	data.attributes.is-delivery	boolean	is-delivery
agreement-refused	data.attributes.agreement-refused	boolean	agreement-refused
pov-key	data.attributes.pov-key	string	pov-key
user-data	data.attributes.user-data	array of object	user-data
field	data.attributes.user-data.field	string	field
value	data.attributes.user-data.value	string	value
sms-status	data.attributes.sms-status	string	sms-status
approval-status	data.attributes.approval-status	string	approval-status
push-status	data.attributes.push-status	string	push-status
email-status	data.attributes.email-status	string	email-status
slack-status	data.attributes.slack-status	string	slack-status
hipchat-status	data.attributes.hipchat-status	string	hipchat-status
type	data.relationships.location.data.type	string	type
id	data.relationships.location.data.id	string	id
type	data.relationships.employee.data.type	string	type
id	data.relationships.employee.data.id	string	id
type	data.relationships.invite.data.type	string	type
id	data.relationships.invite.data.id	string	id
type	data.relationships.flow.data.type	string	type
id	data.relationships.flow.data.id	string	id
related	data.relationships.previous-entries.links.related	string	related
related	data.relationships.platform-jobs.links.related	string	related
self	links.self	string	self

Get one Invite

Operation ID:

getInviteByID

GET request to retrieve information about a single Invite.

Parameters

Name	Key	Required	Type	Description
invite_id	invite_id	True	string	invite_id
Accept	Accept		string	Accept

Returns

Name	Path	Type	Description
id	data.id	string	id
type	data.type	string	type
full-name	data.attributes.full-name	string	full-name
email	data.attributes.email	string	email
inviter-name	data.attributes.inviter-name	string	inviter-name
expected-arrival-time	data.attributes.expected-arrival-time	string	expected-arrival-time
private-notes	data.attributes.private-notes	string	private-notes
arrived	data.attributes.arrived	boolean	arrived
been-here-before	data.attributes.been-here-before	boolean	been-here-before
flow-name	data.attributes.flow-name	string	flow-name
flow-id	data.attributes.flow-id	integer	flow-id
user-data	data.attributes.user-data	array of object	user-data
field	data.attributes.user-data.field	string	field
value	data.attributes.user-data.value	string	value
additional-guests	data.attributes.additional-guests	integer	additional-guests
guest-updated-at	data.attributes.guest-updated-at	string	guest-updated-at
nda	data.attributes.nda	string	nda
nda-available	data.attributes.nda-available	boolean	nda-available
original-nda-sign-date	data.attributes.original-nda-sign-date	string	original-nda-sign-date
secret-token	data.attributes.secret-token	string	secret-token
approval-status	data.attributes.approval-status	string	approval-status
type	data.relationships.entry.data.type	string	type
id	data.relationships.entry.data.id	string	id
id	data.relationships.location.data.id	string	id
type	data.relationships.location.data.type	string	type
type	data.relationships.flow.data.type	string	type
id	data.relationships.flow.data.id	string	id
type	data.relationships.employee.data.type	string	type
id	data.relationships.employee.data.id	string	id
type	data.relationships.creator.data.type	string	type
id	data.relationships.creator.data.id	string	id
included	included	array of object	included
id	included.id	string	id
type	included.type	string	type
full-name	included.attributes.full-name	string	full-name
email	included.attributes.email	string	email
phone-number	included.attributes.phone-number	string	phone-number
avatar	included.attributes.avatar	string	avatar
created-at	included.attributes.created-at	string	created-at
email-enabled	included.attributes.email-enabled	boolean	email-enabled
sms-enabled	included.attributes.sms-enabled	boolean	sms-enabled
call-enabled	included.attributes.call-enabled	string	call-enabled
slack-enabled	included.attributes.slack-enabled	boolean	slack-enabled
hipchat-enabled	included.attributes.hipchat-enabled	boolean	hipchat-enabled
push-enabled	included.attributes.push-enabled	boolean	push-enabled
invite-push-enabled	included.attributes.invite-push-enabled	boolean	invite-push-enabled
has-profile	included.attributes.has-profile	boolean	has-profile
intercom-identity-hash	included.attributes.intercom-identity-hash	string	intercom-identity-hash
related	included.relationships.location-roles.links.related	string	related
related	included.relationships.company-roles.links.related	string	related
data	included.relationships.emails.data	array of object	data
type	included.relationships.emails.data.type	string	type
id	included.relationships.emails.data.id	string	id
self	links.self	string	self

Update one Invite

Operation ID:

updateInvite

PATCH request to update an Invite's information.

Parameters

Name	Key	Required	Type	Description
invite_id	invite_id	True	string	invite_id
Content-Type	Content-Type		string	Content-Type
id	id		string	id
full-name	full-name		string	full-name
email	email		string	email
inviter-name	inviter-name		string	inviter-name
expected-arrival-time	expected-arrival-time		string	expected-arrival-time (Expected Format: 2019-03-24T21:15:00.000Z)
recurring-rule	recurring-rule		string	recurring-rule
rrule-until	rrule-until		string	rrule-until
private-notes	private-notes		string	private-notes
been-here-before	been-here-before		boolean	been-here-before
additional-guests	additional-guests		integer	additional-guests
skip-guest-notification	skip-guest-notification		boolean	skip-guest-notification
nda	nda		string	nda
guest-updated-at	guest-updated-at		string	guest-updated-at (Formatting: 2019-03-24T21:15:00.000Z)
original-nda-sign-date	original-nda-sign-date		string	original-nda-sign-date
nda-available	nda-available		boolean	nda-available
flow-name	flow-name		string	flow-name
arrived	arrived		boolean	arrived
approval-status	approval-status		string	approval-status
field	field		string	field
value	value		string	value
type	type		string	type
id	id		string	id
type	type		string	type
id	id		string	id (employee)
type	type		string	type
id	id		string	id (location)
type	type		string	type

Returns

Name	Path	Type	Description
id	data.id	string	id
type	data.type	string	type
agreements-status	data.attributes.agreements-status	string	agreements-status
full-name	data.attributes.full-name	string	full-name
email	data.attributes.email	string	email
inviter-name	data.attributes.inviter-name	string	inviter-name
inviter-email	data.attributes.inviter-email	string	inviter-email
expected-arrival-time	data.attributes.expected-arrival-time	string	expected-arrival-time
private-notes	data.attributes.private-notes	string	private-notes
arrived	data.attributes.arrived	boolean	arrived
been-here-before	data.attributes.been-here-before	boolean	been-here-before
flow-name	data.attributes.flow-name	string	flow-name
flow-id	data.attributes.flow-id	integer	flow-id
user-data	data.attributes.user-data	array of object	user-data
field	data.attributes.user-data.field	string	field
value	data.attributes.user-data.value	string	value
additional-guests	data.attributes.additional-guests	integer	additional-guests
guest-updated-at	data.attributes.guest-updated-at	string	guest-updated-at
nda	data.attributes.nda	string	nda
nda-available	data.attributes.nda-available	boolean	nda-available
original-nda-sign-date	data.attributes.original-nda-sign-date	string	original-nda-sign-date
secret-token	data.attributes.secret-token	string	secret-token
group-name	data.attributes.group-name	string	group-name
photo-url	data.attributes.photo-url	string	photo-url
qr-code	data.attributes.qr-code	string	qr-code
qr-code-sent-at	data.attributes.qr-code-sent-at	string	qr-code-sent-at
preregistration-complete	data.attributes.preregistration-complete	string	preregistration-complete
status	data.attributes.approval-status.status	string	status
auto-approved	data.attributes.approval-status.auto-approved	boolean	auto-approved
report	data.attributes.approval-status.report	array of object	report
result	data.attributes.approval-status.report.result	string	result
source	data.attributes.approval-status.report.source	string	source
blacklistReportUUID	data.attributes.approval-status.report.blacklistReportUUID	string	blacklistReportUUID
reason	data.attributes.approval-status.report.reason	string	reason
text	data.attributes.approval-status.report.messages.failure.text	string	text
header	data.attributes.approval-status.report.messages.failure.header	string	header
reviewer-id	data.attributes.approval-status.reviewer-id	string	reviewer-id
reviewer-name	data.attributes.approval-status.reviewer-name	string	reviewer-name
review-note	data.attributes.approval-status.review-note	string	review-note
reviewed-at	data.attributes.approval-status.reviewed-at	string	reviewed-at
type	data.relationships.entry.data.type	string	type
id	data.relationships.entry.data.id	string	id
id	data.relationships.location.data.id	string	id
type	data.relationships.location.data.type	string	type
type	data.relationships.flow.data.type	string	type
id	data.relationships.flow.data.id	string	id
type	data.relationships.employee.data.type	string	type
id	data.relationships.employee.data.id	string	id
type	data.relationships.creator.data.type	string	type
id	data.relationships.creator.data.id	string	id
related	data.relationships.platform-jobs.links.related	string	related
included	included	array of object	included
id	included.id	string	id
type	included.type	string	type
name	included.attributes.name	string	name
self	links.self	string	self

Triggers

Invite-Created Trigger

Trigger an action in MS Flow when an Envoy Invite is created.

Invite-Created Trigger

Operation ID:

InviteCreated

Trigger an action in MS Flow when an Envoy Invite is created.

Parameters

Name	Key	Required	Type	Description
token	token		string	token