Compartilhar via

Envoy (versão prévia)

Um conector envoy que permite que você possa conectar sua conta envoy (nossos pontos de extremidade da API REST) a qualquer outro conector. Um exemplo seria criar convites em massa no Envoy com detalhes de uma planilha do Microsoft Excel Online.

Esse conector está disponível nos seguintes produtos e regiões:

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Equipe de suporte do Envoy
URL https://envoy.help/
Email hi@envoy.com
Metadados do conector
Publicador Envoy, Inc.
Site https://envoy.com/
Política de privacidade https://envoy.com/privacypolicy/
Categorias Business Intelligence; Dados

Na versão 2.0, você também pode usar a criação do Envoy Invite como um gatilho.

Pré-requisitos

Para usar esse conector, você precisará de uma conta do Envoy com nome de usuário e senha. Para disparar a funcionalidade, você também precisará instalar a integração do Envoy "Microsoft Flow".

Como obter credenciais

Para se autenticar no Envoy, você precisará de seu nome de usuário e senha do Envoy.

Para disparar a funcionalidade, você precisará do Token de Instalação fornecido durante a Etapa 2 da configuração de integração do "Microsoft Flow" no Envoy.

Problemas e limitações conhecidos

Neste momento, o único gatilho disponível é a Criação de Convites. Esperamos adicionar mais gatilhos em um futuro próximo.

Criando uma conexão

O conector dá suporte aos seguintes tipos de autenticação:
Default Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: todas as regiões

Parâmetros para criar conexão.

Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
nome de usuário secureString O nome de usuário para esta api Verdade
senha secureString A senha dessa api Verdade

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Adicionar filtro de lista de bloqueios

Solicitação POST para adicionar um filtro de lista de bloqueio
Atualizar um convite

Solicitação patch para atualizar as informações de um convite.
Criar Convites

Esta é a solicitação POST para criar um convite
Obter convites

Solicitação GET para recuperar informações de convite com base na filtragem.
Obter filtros de lista de bloqueios

Solicitação GET para recuperar filtros de lista de blocos.
Obter fluxos

Solicitação GET para recuperar informações sobre os fluxos para sua localização.
Obter informações da empresa

Recuperar informações em torno da empresa (GET)
Obter lista de funcionários

Solicitação GET para recuperar a lista de funcionários
Obter locais

Solicitação GET para recuperar locais
Obter um convite

Solicitação GET para recuperar informações sobre um único Convite.
Obter uma entrada

Solicitação GET para recuperar informações sobre uma única Entrada.

Adicionar filtro de lista de bloqueios

ID da operação:
addBlockListFilter

Solicitação POST para adicionar um filtro de lista de bloqueio

Parâmetros

Nome Chave Obrigatório Tipo Description
aliases
 aliases array of

aliases
descrição
 description string

descrição
e-mails
 emails array of string

e-mails
nome completo
 full-name string

nome completo
palavra-chave
 keyword string

palavra-chave
outras palavras-chave
 other-keywords array of

outras palavras-chave
reason
 reason string

reason
números de telefone
 phone-numbers array of

números de telefone
tipo
 type string

tipo
id
 id string

id (local)
tipo
 type string

tipo

Retornos

Nome Caminho Tipo Description
id
 data.id string

id
tipo
 data.type string

tipo
self
 data.links.self string

self
aliases
 data.attributes.aliases array of

aliases
descrição
 data.attributes.description string

descrição
e-mails
 data.attributes.emails array of string

e-mails
nome completo
 data.attributes.full-name string

nome completo
palavra-chave
 data.attributes.keyword string

palavra-chave
outras palavras-chave
 data.attributes.other-keywords array of

outras palavras-chave
números de telefone
 data.attributes.phone-numbers array of

números de telefone
Original
 data.attributes.photo.original string

Original
polegar
 data.attributes.photo.thumb string

polegar
reason
 data.attributes.reason string

reason
criado por
 data.attributes.created-by string

criado por
self
 data.relationships.location.links.self string

self
relacionado
 data.relationships.location.links.related string

relacionado
self
 data.relationships.user.links.self string

self
relacionado
 data.relationships.user.links.related string

relacionado

Atualizar um convite

ID da operação:
updateInvite

Solicitação patch para atualizar as informações de um convite.

Parâmetros

Nome Chave Obrigatório Tipo Description
invite_id
 invite_id True string

invite_id
Tipo de conteúdo
 Content-Type string

Tipo de conteúdo
id
 id string

id
nome completo
 full-name string

nome completo
email
 email string

email
nome do convidado
 inviter-name string

nome do convidado
expected-arrival-time
 expected-arrival-time string

expected-arrival-time (Formato esperado: 2019-03-24T21:15:00.000Z)
regra recorrente
 recurring-rule string

regra recorrente
rrule-until
 rrule-until string

rrule-until
notas privadas
 private-notes string

notas privadas
been-here-before
 been-here-before boolean

been-here-before
convidados adicionais
 additional-guests integer

convidados adicionais
skip-guest-notification
 skip-guest-notification boolean

skip-guest-notification
Nda
 nda string

Nda
guest-updated-at
 guest-updated-at string

guest-updated-at (Formatação: 2019-03-24T21:15:00.000Z)
original-nda-sign-date
 original-nda-sign-date string

original-nda-sign-date
disponível para nda
 nda-available boolean

disponível para nda
nome do fluxo
 flow-name string

nome do fluxo
Chegou
 arrived boolean

Chegou
status de aprovação
 approval-status string

status de aprovação
campo
 field string

campo
value
 value string

value
tipo
 type string

tipo
id
 id string

id
tipo
 type string

tipo
id
 id string

id (funcionário)
tipo
 type string

tipo
id
 id string

id (local)
tipo
 type string

tipo

Retornos

Nome Caminho Tipo Description
id
 data.id string

id
tipo
 data.type string

tipo
agreements-status
 data.attributes.agreements-status string

agreements-status
nome completo
 data.attributes.full-name string

nome completo
email
 data.attributes.email string

email
nome do convidado
 data.attributes.inviter-name string

nome do convidado
inviter-email
 data.attributes.inviter-email string

inviter-email
expected-arrival-time
 data.attributes.expected-arrival-time string

expected-arrival-time
notas privadas
 data.attributes.private-notes string

notas privadas
Chegou
 data.attributes.arrived boolean

Chegou
been-here-before
 data.attributes.been-here-before boolean

been-here-before
nome do fluxo
 data.attributes.flow-name string

nome do fluxo
id de fluxo
 data.attributes.flow-id integer

id de fluxo
dados do usuário
 data.attributes.user-data array of object

dados do usuário
campo
 data.attributes.user-data.field string

campo
value
 data.attributes.user-data.value string

value
convidados adicionais
 data.attributes.additional-guests integer

convidados adicionais
guest-updated-at
 data.attributes.guest-updated-at string

guest-updated-at
Nda
 data.attributes.nda string

Nda
disponível para nda
 data.attributes.nda-available boolean

disponível para nda
original-nda-sign-date
 data.attributes.original-nda-sign-date string

original-nda-sign-date
secret-token
 data.attributes.secret-token string

secret-token
nome do grupo
 data.attributes.group-name string

nome do grupo
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
pré-registro concluído
 data.attributes.preregistration-complete string

pré-registro concluído
status
 data.attributes.approval-status.status string

status
aprovado automaticamente
 data.attributes.approval-status.auto-approved boolean

aprovado automaticamente
relatório
 data.attributes.approval-status.report array of object

relatório
resultado
 data.attributes.approval-status.report.result string

resultado
fonte
 data.attributes.approval-status.report.source string

fonte
blacklistReportUUID
 data.attributes.approval-status.report.blacklistReportUUID string

blacklistReportUUID
reason
 data.attributes.approval-status.report.reason string

reason
enviar SMS
 data.attributes.approval-status.report.messages.failure.text string

enviar SMS
cabeçalho
 data.attributes.approval-status.report.messages.failure.header string

cabeçalho
reviewer-id
 data.attributes.approval-status.reviewer-id string

reviewer-id
nome do revisor
 data.attributes.approval-status.reviewer-name string

nome do revisor
revisão-observação
 data.attributes.approval-status.review-note string

revisão-observação
revisado em
 data.attributes.approval-status.reviewed-at string

revisado em
tipo
 data.relationships.entry.data.type string

tipo
id
 data.relationships.entry.data.id string

id
id
 data.relationships.location.data.id string

id
tipo
 data.relationships.location.data.type string

tipo
tipo
 data.relationships.flow.data.type string

tipo
id
 data.relationships.flow.data.id string

id
tipo
 data.relationships.employee.data.type string

tipo
id
 data.relationships.employee.data.id string

id
tipo
 data.relationships.creator.data.type string

tipo
id
 data.relationships.creator.data.id string

id
relacionado
 data.relationships.platform-jobs.links.related string

relacionado
incluído
 included array of object

incluído
id
 included.id string

id
tipo
 included.type string

tipo
nome
 included.attributes.name string

nome
self
 links.self string

self

Criar Convites

ID da operação:
addInvite

Esta é a solicitação POST para criar um convite

Parâmetros

Nome Chave Obrigatório Tipo Description
Tipo de conteúdo
 Content-Type string

Tipo de conteúdo
nome completo
 full-name string

nome completo
email
 email string

email
nome do convidado
 inviter-name string

nome do convidado
expected-arrival-time
 expected-arrival-time string

expected-arrival-time
regra recorrente
 recurring-rule string

regra recorrente
rrule-until
 rrule-until string

rrule-until
notas privadas
 private-notes string

notas privadas
been-here-before
 been-here-before boolean

been-here-before
convidados adicionais
 additional-guests integer

convidados adicionais
skip-guest-notification
 skip-guest-notification boolean

skip-guest-notification
agreements-status
 agreements-status string

agreements-status
place-id
 place-id string

place-id
nome do fluxo
 flow-name string

nome do fluxo
nome do grupo
 group-name string

nome do grupo
Chegou
 arrived boolean

Chegou
status de aprovação
 approval-status string

status de aprovação
campo
 field string

campo
value
 value string

value
tipo
 type string

tipo
id
 id string

id (funcionário)
tipo
 type string

tipo
id
 id string

id (local)
tipo
 type string

tipo

Retornos

Nome Caminho Tipo Description
id
 data.id string

id
tipo
 data.type string

tipo
self
 data.links.self string

self
convidados adicionais
 data.attributes.additional-guests integer

convidados adicionais
status
 data.attributes.approval-status.status string

status
auto_approved
 data.attributes.approval-status.auto_approved boolean

auto_approved
relatório
 data.attributes.approval-status.report array of object

relatório
resultado
 data.attributes.approval-status.report.result string

resultado
fonte
 data.attributes.approval-status.report.source string

fonte
blacklistReportUUID
 data.attributes.approval-status.report.blacklistReportUUID string

blacklistReportUUID
reason
 data.attributes.approval-status.report.reason string

reason
enviar SMS
 data.attributes.approval-status.report.messages.failure.text string

enviar SMS
cabeçalho
 data.attributes.approval-status.report.messages.failure.header string

cabeçalho
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
nome completo
 data.attributes.full-name string

nome completo
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
nome
 data.attributes.location-info.name string

nome
logo_url
 data.attributes.location-info.logo_url string

logo_url
notas privadas
 data.attributes.private-notes string

notas privadas
dados do usuário
 data.attributes.user-data array of object

dados do usuário
data.attributes.user-data.field string

campo
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
Chegou
 data.attributes.arrived boolean

Chegou
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
relacionado
 data.relationships.attendee.links.related string

relacionado
self
 data.relationships.creator.links.self string

self
relacionado
 data.relationships.creator.links.related string

relacionado
self
 data.relationships.employee.links.self string

self
relacionado
 data.relationships.employee.links.related string

relacionado
tipo
 data.relationships.employee.data.type string

tipo
id
 data.relationships.employee.data.id string

id
self
 data.relationships.entry.links.self string

self
relacionado
 data.relationships.entry.links.related string

relacionado
tipo
 data.relationships.entry.data.type object

tipo
id
 data.relationships.entry.data.id string

id
self
 data.relationships.flow.links.self string

self
relacionado
 data.relationships.flow.links.related string

relacionado
tipo
 data.relationships.flow.data.type string

tipo
id
 data.relationships.flow.data.id string

id
self
 data.relationships.location.links.self string

self
relacionado
 data.relationships.location.links.related string

relacionado
tipo
 data.relationships.location.data.type string

tipo
id
 data.relationships.location.data.id string

id
self
 data.relationships.platform-jobs.links.self string

self
relacionado
 data.relationships.platform-jobs.links.related string

relacionado

Obter convites

ID da operação:
getInviteInfo

Solicitação GET para recuperar informações de convite com base na filtragem.

Parâmetros

Nome Chave Obrigatório Tipo Description
filter[location]
 filter[location] integer

filter[location]
filter[date]
 filter[date] string

filter[date]
Aceitar
 Accept string

Aceitar

Retornos

Nome Caminho Tipo Description
dados
 data array of object

dados
id
 data.id string

id
tipo
 data.type string

tipo
self
 data.links.self string

self
convidados adicionais
 data.attributes.additional-guests integer

convidados adicionais
status
 data.attributes.approval-status.status string

status
auto_approved
 data.attributes.approval-status.auto_approved boolean

auto_approved
relatório
 data.attributes.approval-status.report array of object

relatório
resultado
 data.attributes.approval-status.report.result string

resultado
fonte
 data.attributes.approval-status.report.source string

fonte
blacklistReportUUID
 data.attributes.approval-status.report.blacklistReportUUID string

blacklistReportUUID
reason
 data.attributes.approval-status.report.reason string

reason
enviar SMS
 data.attributes.approval-status.report.messages.failure.text string

enviar SMS
cabeçalho
 data.attributes.approval-status.report.messages.failure.header string

cabeçalho
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
nome completo
 data.attributes.full-name string

nome completo
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
nome
 data.attributes.location-info.name string

nome
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
notas privadas
 data.attributes.private-notes string

notas privadas
dados do usuário
 data.attributes.user-data array of object

dados do usuário
campo
 data.attributes.user-data.field string

campo
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
Chegou
 data.attributes.arrived boolean

Chegou
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
atestado
 data.attributes.attested string

atestado
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
relacionado
 data.relationships.attendee.links.related string

relacionado
self
 data.relationships.creator.links.self string

self
relacionado
 data.relationships.creator.links.related string

relacionado
self
 data.relationships.employee.links.self string

self
relacionado
 data.relationships.employee.links.related string

relacionado
tipo
 data.relationships.employee.data.type string

tipo
id
 data.relationships.employee.data.id string

id
self
 data.relationships.entry.links.self string

self
relacionado
 data.relationships.entry.links.related string

relacionado
tipo
 data.relationships.entry.data.type string

tipo
id
 data.relationships.entry.data.id string

id
self
 data.relationships.flow.links.self string

self
relacionado
 data.relationships.flow.links.related string

relacionado
tipo
 data.relationships.flow.data.type string

tipo
id
 data.relationships.flow.data.id string

id
self
 data.relationships.location.links.self string

self
relacionado
 data.relationships.location.links.related string

relacionado
tipo
 data.relationships.location.data.type string

tipo
id
 data.relationships.location.data.id string

id
self
 data.relationships.platform-jobs.links.self string

self
relacionado
 data.relationships.platform-jobs.links.related string

relacionado
total
 meta.total integer

total
primeiro
 links.first string

primeiro
próximo
 links.next string

próximo
último
 links.last string

último

Obter filtros de lista de bloqueios

ID da operação:
getblockListFilters

Solicitação GET para recuperar filtros de lista de blocos.

Parâmetros

Nome Chave Obrigatório Tipo Description
filter[company]
 filter[company] integer

filter[company]
Tipo de conteúdo
 Content-Type string

Tipo de conteúdo

Retornos

Nome Caminho Tipo Description
dados
 data array of object

dados
id
 data.id string

id
tipo
 data.type string

tipo
self
 data.links.self string

self
aliases
 data.attributes.aliases array of

aliases
descrição
 data.attributes.description string

descrição
e-mails
 data.attributes.emails array of string

e-mails
nome completo
 data.attributes.full-name string

nome completo
palavra-chave
 data.attributes.keyword string

palavra-chave
outras palavras-chave
 data.attributes.other-keywords array of string

outras palavras-chave
números de telefone
 data.attributes.phone-numbers array of

números de telefone
Original
 data.attributes.photo.original string

Original
polegar
 data.attributes.photo.thumb string

polegar
reason
 data.attributes.reason string

reason
image-url
 data.attributes.image-url string

image-url
external-id
 data.attributes.external-id string

external-id
criado por
 data.attributes.created-by string

criado por
self
 data.relationships.location.links.self string

self
relacionado
 data.relationships.location.links.related string

relacionado
self
 data.relationships.user.links.self string

self
relacionado
 data.relationships.user.links.related string

relacionado
total
 meta.total integer

total

Obter fluxos

ID da operação:
getFlowsInfo

Solicitação GET para recuperar informações sobre os fluxos para sua localização.

Parâmetros

Nome Chave Obrigatório Tipo Description
filter[location]
 filter[location] integer

filter[location]

Retornos

Nome Caminho Tipo Description
dados
 data array of object

dados
id
 data.id string

id
tipo
 data.type string

tipo
self
 data.links.self string

self
convidados adicionais
 data.attributes.additional-guests boolean

convidados adicionais
auto-sign-out-minutes
 data.attributes.auto-sign-out-minutes string

auto-sign-out-minutes
auto-sair à meia-noite
 data.attributes.auto-sign-out-at-midnight boolean

auto-sair à meia-noite
habilitado para selo
 data.attributes.badge-enabled boolean

habilitado para selo
enabled
 data.attributes.enabled boolean

enabled
id-check
 data.attributes.id-check boolean

id-check
nomes localizados em ipad
 data.attributes.ipad-localized-names array of object

nomes localizados em ipad
código de linguagem
 data.attributes.ipad-localized-names.language-code string

código de linguagem
region-code
 data.attributes.ipad-localized-names.region-code string

region-code
display-name
 data.attributes.ipad-localized-names.display-name string

display-name
nome
 data.attributes.name string

nome
posição
 data.attributes.position integer

posição
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
relacionado
 data.relationships.agreement-page.links.related string

relacionado
self
 data.relationships.badge.links.self string

self
relacionado
 data.relationships.badge.links.related string

relacionado
self
 data.relationships.location.links.self string

self
relacionado
 data.relationships.location.links.related string

relacionado
self
 data.relationships.photo-page.links.self string

self
relacionado
 data.relationships.photo-page.links.related string

relacionado
self
 data.relationships.sign-in-field-page.links.self string

self
relacionado
 data.relationships.sign-in-field-page.links.related string

relacionado
self
 data.relationships.summary-page.links.self string

self
relacionado
 data.relationships.summary-page.links.related string

relacionado
total
 meta.total integer

total
primeiro
 links.first string

primeiro
último
 links.last string

último

Obter informações da empresa

ID da operação:
getCompanyInfo

Recuperar informações em torno da empresa (GET)

Parâmetros

Nome Chave Obrigatório Tipo Description
Aceitar
 Accept string

Aceitar

Retornos

Nome Caminho Tipo Description
total
 meta.total integer

total
limit
 meta.limit integer

limit
deslocamento
 meta.offset integer

deslocamento
dados
 data array of object

dados
id
 data.id string

id
tipo
 data.type string

tipo
nome
 data.attributes.name string

nome
plan-intent
 data.attributes.plan-intent string

plan-intent
buy-intent
 data.attributes.buy-intent boolean

buy-intent
habilitado para chamadas
 data.attributes.call-enabled boolean

habilitado para chamadas
habilitado para appletv
 data.attributes.appletv-enabled boolean

habilitado para appletv
conectado a saml
 data.attributes.saml-connected boolean

conectado a saml
ativo
 data.attributes.active boolean

ativo
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
status de integração
 data.attributes.onboarding-status string

status de integração
onboarding-locations-count
 data.attributes.onboarding-locations-count string

onboarding-locations-count
is-beta
 data.attributes.is-beta boolean

is-beta
Plug-ins de adhoc
 data.attributes.adhoc-plugins array of

Plug-ins de adhoc
cached-locations-quantity
 data.attributes.cached-locations-quantity integer

cached-locations-quantity
tipo
 data.relationships.subscription.data.type string

tipo
id
 data.relationships.subscription.data.id string

id
tipo
 data.relationships.deliveries-subscription.data.type string

tipo
id
 data.relationships.deliveries-subscription.data.id string

id
dados
 data.relationships.contracts.data array of object

dados
tipo
 data.relationships.contracts.data.type string

tipo
id
 data.relationships.contracts.data.id string

id
dados
 data.relationships.administrators.data array of object

dados
tipo
 data.relationships.administrators.data.type string

tipo
id
 data.relationships.administrators.data.id string

id
dados
 data.relationships.locations.data array of object

dados
tipo
 data.relationships.locations.data.type string

tipo
id
 data.relationships.locations.data.id string

id
tipo
 data.relationships.saml.data.type string

tipo
id
 data.relationships.saml.data.id string

id
self
 links.self string

self
primeiro
 links.first string

primeiro
último
 links.last string

último

Obter lista de funcionários

ID da operação:
getEmployee

Solicitação GET para recuperar a lista de funcionários

Retornos

Nome Caminho Tipo Description
dados
 data array of object

dados
id
 data.id string

id
tipo
 data.type string

tipo
self
 data.links.self string

self
cc-employee
 data.attributes.cc-employee boolean

cc-employee
id da empresa
 data.attributes.company-id integer

id da empresa
excluído
 data.attributes.deleted boolean

excluído
não sincronizar
 data.attributes.do-not-sync boolean

não sincronizar
email
 data.attributes.email string

email
hide-from-host-list
 data.attributes.hide-from-host-list boolean

hide-from-host-list
adicionado manualmente
 data.attributes.manually-added boolean

adicionado manualmente
manualmente-added-location-present
 data.attributes.manually-added-location-present boolean

manualmente-added-location-present
nome
 data.attributes.name string

nome
número de telefone
 data.attributes.phone-number string

número de telefone
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
relacionado
 data.relationships.company.links.related string

relacionado
self
 data.relationships.user.links.self string

self
relacionado
 data.relationships.user.links.related string

relacionado
self
 data.relationships.assistants.links.self string

self
relacionado
 data.relationships.assistants.links.related string

relacionado
self
 data.relationships.bosses.links.self string

self
relacionado
 data.relationships.bosses.links.related string

relacionado
self
 data.relationships.employee-locations.links.self string

self
relacionado
 data.relationships.employee-locations.links.related string

relacionado
self
 data.relationships.locations.links.self string

self
relacionado
 data.relationships.locations.links.related string

relacionado
total
 meta.total integer

total
primeiro
 links.first string

primeiro
último
 links.last string

último

Obter locais

ID da operação:
getLocationInfo

Solicitação GET para recuperar locais

Parâmetros

Nome Chave Obrigatório Tipo Description
Aceitar
 Accept string

Aceitar

Retornos

Nome Caminho Tipo Description
dados
 data array of object

dados
id
 data.id string

id
tipo
 data.type string

tipo
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-sair à meia-noite
 data.attributes.auto-sign-out-at-midnight boolean

auto-sair à meia-noite
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
desabilitado
 data.attributes.disabled boolean

desabilitado
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
habilitado para fallback-notifications
 data.attributes.fallback-notifications-enabled boolean

habilitado para fallback-notifications
pré-registro-obrigatório habilitado
 data.attributes.pre-registration-required-enabled boolean

pré-registro-obrigatório habilitado
latitude
 data.attributes.latitude float

latitude
localidade
 data.attributes.locale string

localidade
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
nome
 data.attributes.name string

nome
notificações habilitadas para impressora
 data.attributes.printer-notifications-enabled boolean

notificações habilitadas para impressora
habilitado para vários idiomas
 data.attributes.multiple-languages-enabled boolean

habilitado para vários idiomas
localidades habilitadas
 data.attributes.enabled-locales array of

localidades habilitadas
estado
 data.attributes.state string

estado
timezone
 data.attributes.timezone string

timezone
zip
 data.attributes.zip string

zip
média mensal de visitantes
 data.attributes.average-monthly-visitors float

média mensal de visitantes
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
relacionado
 data.relationships.company.links.related string

relacionado
self
 data.relationships.device-config.links.self string

self
relacionado
 data.relationships.device-config.links.related string

relacionado
self
 data.relationships.gdpr-configuration.links.self string

self
relacionado
 data.relationships.gdpr-configuration.links.related string

relacionado
self
 data.relationships.printer.links.self string

self
relacionado
 data.relationships.printer.links.related string

relacionado
self
 data.relationships.devices.links.self string

self
relacionado
 data.relationships.devices.links.related string

relacionado
self
 data.relationships.employees.links.self string

self
relacionado
 data.relationships.employees.links.related string

relacionado
self
 data.relationships.fallback-contacts.links.self string

self
relacionado
 data.relationships.fallback-contacts.links.related string

relacionado
self
 data.relationships.flows.links.self string

self
relacionado
 data.relationships.flows.links.related string

relacionado
self
 data.relationships.locations-setup-guide-steps.links.self string

self
relacionado
 data.relationships.locations-setup-guide-steps.links.related string

relacionado
self
 data.relationships.printers.links.self string

self
relacionado
 data.relationships.printers.links.related string

relacionado
self
 data.relationships.printer-contacts.links.self string

self
relacionado
 data.relationships.printer-contacts.links.related string

relacionado
total
 meta.total integer

total
primeiro
 links.first string

primeiro
último
 links.last string

último

Obter um convite

ID da operação:
getInviteByID

Solicitação GET para recuperar informações sobre um único Convite.

Parâmetros

Nome Chave Obrigatório Tipo Description
invite_id
 invite_id True string

invite_id
Aceitar
 Accept string

Aceitar

Retornos

Nome Caminho Tipo Description
id
 data.id string

id
tipo
 data.type string

tipo
nome completo
 data.attributes.full-name string

nome completo
email
 data.attributes.email string

email
nome do convidado
 data.attributes.inviter-name string

nome do convidado
expected-arrival-time
 data.attributes.expected-arrival-time string

expected-arrival-time
notas privadas
 data.attributes.private-notes string

notas privadas
Chegou
 data.attributes.arrived boolean

Chegou
been-here-before
 data.attributes.been-here-before boolean

been-here-before
nome do fluxo
 data.attributes.flow-name string

nome do fluxo
id de fluxo
 data.attributes.flow-id integer

id de fluxo
dados do usuário
 data.attributes.user-data array of object

dados do usuário
campo
 data.attributes.user-data.field string

campo
value
 data.attributes.user-data.value string

value
convidados adicionais
 data.attributes.additional-guests integer

convidados adicionais
guest-updated-at
 data.attributes.guest-updated-at string

guest-updated-at
Nda
 data.attributes.nda string

Nda
disponível para nda
 data.attributes.nda-available boolean

disponível para nda
original-nda-sign-date
 data.attributes.original-nda-sign-date string

original-nda-sign-date
secret-token
 data.attributes.secret-token string

secret-token
status de aprovação
 data.attributes.approval-status string

status de aprovação
tipo
 data.relationships.entry.data.type string

tipo
id
 data.relationships.entry.data.id string

id
id
 data.relationships.location.data.id string

id
tipo
 data.relationships.location.data.type string

tipo
tipo
 data.relationships.flow.data.type string

tipo
id
 data.relationships.flow.data.id string

id
tipo
 data.relationships.employee.data.type string

tipo
id
 data.relationships.employee.data.id string

id
tipo
 data.relationships.creator.data.type string

tipo
id
 data.relationships.creator.data.id string

id
incluído
 included array of object

incluído
id
 included.id string

id
tipo
 included.type string

tipo
nome completo
 included.attributes.full-name string

nome completo
email
 included.attributes.email string

email
número de telefone
 included.attributes.phone-number string

número de telefone
Avatar
 included.attributes.avatar string

Avatar
created-at
 included.attributes.created-at string

created-at
habilitado para email
 included.attributes.email-enabled boolean

habilitado para email
habilitado para sms
 included.attributes.sms-enabled boolean

habilitado para sms
habilitado para chamadas
 included.attributes.call-enabled string

habilitado para chamadas
habilitado para slack
 included.attributes.slack-enabled boolean

habilitado para slack
habilitado para hipchat
 included.attributes.hipchat-enabled boolean

habilitado para hipchat
habilitado por push
 included.attributes.push-enabled boolean

habilitado por push
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
relacionado
 included.relationships.location-roles.links.related string

relacionado
relacionado
 included.relationships.company-roles.links.related string

relacionado
dados
 included.relationships.emails.data array of object

dados
tipo
 included.relationships.emails.data.type string

tipo
id
 included.relationships.emails.data.id string

id
self
 links.self string

self

Obter uma entrada

ID da operação:
getEntryInfoByID

Solicitação GET para recuperar informações sobre uma única Entrada.

Parâmetros

Nome Chave Obrigatório Tipo Description
entry_id
 entry_id True string

entry_id
filter[location]
 filter[location] integer

filter[location]
Aceitar
 Accept string

Aceitar

Retornos

Nome Caminho Tipo Description
id
 data.id string

id
tipo
 data.type string

tipo
nome completo
 data.attributes.full-name string

nome completo
email
 data.attributes.email string

email
hospedar
 data.attributes.host string

hospedar
host-email
 data.attributes.host-email string

host-email
notas privadas
 data.attributes.private-notes string

notas privadas
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
grande
 data.attributes.thumbnails.large string

grande
pequeno
 data.attributes.thumbnails.small string

pequeno
nome do fluxo
 data.attributes.flow-name string

nome do fluxo
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
dados do usuário
 data.attributes.user-data array of object

dados do usuário
campo
 data.attributes.user-data.field string

campo
value
 data.attributes.user-data.value string

value
sms-status
 data.attributes.sms-status string

sms-status
status de aprovação
 data.attributes.approval-status string

status de aprovação
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
tipo
 data.relationships.location.data.type string

tipo
id
 data.relationships.location.data.id string

id
tipo
 data.relationships.employee.data.type string

tipo
id
 data.relationships.employee.data.id string

id
tipo
 data.relationships.invite.data.type string

tipo
id
 data.relationships.invite.data.id string

id
tipo
 data.relationships.flow.data.type string

tipo
id
 data.relationships.flow.data.id string

id
relacionado
 data.relationships.previous-entries.links.related string

relacionado
relacionado
 data.relationships.platform-jobs.links.related string

relacionado
self
 links.self string

self

Gatilhos

Gatilho Invite-Created

Dispare uma ação no MS Flow quando um Convite do Envoy for criado.

Gatilho Invite-Created

ID da operação:
InviteCreated

Dispare uma ação no MS Flow quando um Convite do Envoy for criado.

Parâmetros

Nome Chave Obrigatório Tipo Description
símbolo
 token string

símbolo