Envoy (Preview)

An Envoy connector that allows you to be able to connect your Envoy account (our REST API endpoints) to any other Flow 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
Flow Premium All Flow regions except the following:
     -   US Government (GCC)
PowerApps Premium All PowerApps regions except the following:
     -   US Government (GCC)

Creating a connection

To connect your account, you will need the following information:

Name Type Description
Username securestring

The username for your Envoy account

Password securestring

The password for your Envoy account

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

addBlockListFilter

addBlockListFilter

Create Invites

This is the POST request to create an invite

getBlockListFilters

GET request to retrieve block list filters.

getCompanyInformation

Retrieve information around the company (GET)

getEmployeesList

GET request to retrieve the employees list

getEntryInformation

Retrieve Employee Information with filtering by ID and location

getFlowsInfo

Get information around the flows from your location.

getInviteByID

GET request to retrieve an invite by ID

getInviteInfo

Retrieve invite information based on filtering.

getLocations

Retrieve Location based data (GET)

Update the invite

Patch request to update invite information

addBlockListFilter

addBlockListFilter

Parameters

Name Key Required Type Description
aliases
aliases

addBlockListFilter

description
description string

description

emails
emails string

addBlockListFilter

full-name
full-name string

full-name

keyword
keyword string

keyword

other-keywords
other-keywords

addBlockListFilter

reason
reason string

reason

phone-numbers
phone-numbers

addBlockListFilter

type string

type

id string

id (location)

type string

type

Returns

Create Invites

This is the POST request to create an invite

Parameters

Name Key Required Type Description
Content-Type
Content-Type string

This is the POST request to create an invite

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 string

recurring-rule

rrule-until string

rrule-until

private-notes
private-notes string

private-notes

been-here-before boolean

been-here-before

additional-guests integer

additional-guests

skip-guest-notification boolean

skip-guest-notification

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 string

approval-status

field string

field

value string

value

type string

type

id string

id (employee)

type string

type

id string

id (location)

type string

type

Returns

getBlockListFilters

GET request to retrieve block list filters.

Parameters

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

GET request to retrieve block list filters.

Content-Type
Content-Type string

GET request to retrieve block list filters.

Returns

getCompanyInformation

Retrieve information around the company (GET)

Parameters

Name Key Required Type Description
Accept
Accept string

Retrieve information around the company (GET)

Returns

getEmployeesList

GET request to retrieve the employees list

Returns

getEntryInformation

Retrieve Employee Information with filtering by ID and location

Parameters

Name Key Required Type Description
entry_id
entry_id True string

Retrieve Employee Information with filtering by ID and location

filter[location]
filter[location] integer

Retrieve Employee Information with filtering by ID and location

Accept
Accept string

Retrieve Employee Information with filtering by ID and location

Returns

getFlowsInfo

Get information around the flows from your location.

Parameters

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

Get information around the flows from your location.

Returns

getInviteByID

GET request to retrieve an invite by ID

Parameters

Name Key Required Type Description
invite_id
invite_id True string

GET request to retrieve an invite by ID

Accept
Accept string

GET request to retrieve an invite by ID

Returns

getInviteInfo

Retrieve invite information based on filtering.

Parameters

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

Retrieve invite information based on filtering.

filter[date]
filter[date] string

Retrieve invite information based on filtering.

Accept
Accept string

Retrieve invite information based on filtering.

Returns

getLocations

Retrieve Location based data (GET)

Parameters

Name Key Required Type Description
Accept
Accept string

Retrieve Location based data (GET)

Returns

Update the invite

Patch request to update invite information

Parameters

Name Key Required Type Description
invite_id
invite_id True string

Patch request to update invite information

Content-Type
Content-Type string

Patch request to update invite information

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 string

expected-arrival-time (Expected Format: 2019-03-24T21:15:00.000Z)

recurring-rule string

recurring-rule

rrule-until string

rrule-until

private-notes
private-notes string

private-notes

been-here-before boolean

been-here-before

additional-guests integer

additional-guests

skip-guest-notification boolean

skip-guest-notification

nda string

nda

guest-updated-at string

guest-updated-at (Formatting: 2019-03-24T21:15:00.000Z)

original-nda-sign-date string

original-nda-sign-date

nda-available boolean

nda-available

flow-name
flow-name string

flow-name

arrived boolean

arrived

approval-status string

approval-status

field string

field

value string

value

data string

data

type string

type

id string

id (employee)

type string

type

id string

id (location)

type string

type

Returns