Envoy (anteprima)
Connettore Envoy che consente di connettere l'account Envoy (endpoint API REST) a qualsiasi altro connettore. Un esempio potrebbe essere quello di creare inviti in blocco in Envoy con i dettagli di un foglio di calcolo di Microsoft Excel Online.
Questo connettore è disponibile nei prodotti e nelle aree seguenti:
| Servizio | Class | Regions |
|---|---|---|
| Copilot Studio | Di alta qualità | Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| App per la logica | Normale | Tutte le aree di App per la logica , ad eccezione delle seguenti: - Aree di Azure per enti pubblici - Aree di Azure Cina - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Apps | Di alta qualità | Tutte le aree di Power Apps , ad eccezione dei seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Automate | Di alta qualità | Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Contatto | |
|---|---|
| Nome | Team di supporto di Envoy |
| URL | https://envoy.help/ |
| hi@envoy.com |
| Metadati del connettore | |
|---|---|
| Editore | Envoy, Inc. |
| Sito web | https://envoy.com/ |
| Informativa sulla privacy | https://envoy.com/privacypolicy/ |
| Categorie | Business intelligence; Dati |
Nella versione 2.0 è anche possibile usare la creazione di Envoy Invite come trigger.
Prerequisiti
Per usare questo connettore, è necessario un account Envoy con nome utente e password. Per la funzionalità di attivazione, è anche necessario installare l'integrazione envoy "Microsoft Flow".
Come ottenere le credenziali
Per eseguire l'autenticazione a Envoy, è necessario il nome utente e la password di Envoy.
Per attivare la funzionalità, è necessario il token di installazione fornito durante il passaggio 2 della configurazione dell'integrazione di "Microsoft Flow" all'interno di Envoy.
Problemi noti e limitazioni
Al momento, l'unico trigger disponibile è La creazione dell'invito. Ci aspettiamo di aggiungere altri trigger nel prossimo futuro.
Creazione di una connessione
Il connettore supporta i tipi di autenticazione seguenti:
| Predefinita | Parametri per la creazione della connessione. | Tutte le aree geografiche | Non condivisibile |
Predefinito
Applicabile: tutte le aree
Parametri per la creazione della connessione.
Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.
| Nome | TIPO | Description | Obbligatorio |
|---|---|---|---|
| username | securestring | Nome utente per questa API | Vero |
| parola d’ordine | securestring | Password per questa API | Vero |
Limiti per la limitazione delle richieste
| Nome | Chiamate | Periodo di rinnovo |
|---|---|---|
| Chiamate API per connessione | 100 | 60 secondi |
Azioni
| Aggiornare un invito |
Richiesta PATCH per aggiornare le informazioni di un invito. |
| Aggiungere un filtro blocklist |
Richiesta POST per aggiungere un filtro blocklist |
| Creare inviti |
Si tratta della richiesta POST per creare un invito |
| Ottenere flussi |
Richiesta GET per recuperare informazioni sui flussi per la posizione. |
| Ottenere gli inviti |
Richiesta GET per recuperare le informazioni sull'invito in base al filtro. |
| Ottenere i filtri dell'elenco di blocchi |
Richiesta GET per recuperare i filtri dell'elenco di blocchi. |
| Ottenere informazioni aziendali |
Recuperare informazioni relative all'azienda (GET) |
| Ottenere l'elenco dei dipendenti |
Richiesta GET per recuperare l'elenco dei dipendenti |
| Ottenere le posizioni |
Richiesta GET per il recupero dei percorsi |
| Ottenere una voce |
Richiesta GET per recuperare informazioni su una singola voce. |
| Ottieni un invito |
Richiesta GET per recuperare informazioni su un singolo invito. |
Aggiornare un invito
Richiesta PATCH per aggiornare le informazioni di un invito.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
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 |
|
|
posta elettronica
|
string |
posta elettronica |
||
|
inviter-name
|
inviter-name | string |
inviter-name |
|
|
previsto-ora di arrivo
|
expected-arrival-time | string |
previsto-arrivo-ora (formato previsto: 2019-03-24T21:15:00.000Z) |
|
|
regola ricorrente
|
recurring-rule | string |
regola ricorrente |
|
|
rrule-until
|
rrule-until | string |
rrule-until |
|
|
note private
|
private-notes | string |
note private |
|
|
been-here-before
|
been-here-before | boolean |
been-here-before |
|
|
guest aggiuntivi
|
additional-guests | integer |
guest aggiuntivi |
|
|
skip-guest-notification
|
skip-guest-notification | boolean |
skip-guest-notification |
|
|
Nda
|
nda | string |
Nda |
|
|
guest-updated-at
|
guest-updated-at | string |
guest-updated-at (Formattazione: 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 |
|
|
arrivato
|
arrived | boolean |
arrivato |
|
|
stato approvazione
|
approval-status | string |
stato approvazione |
|
|
field
|
field | string |
field |
|
|
value
|
value | string |
value |
|
|
type
|
type | string |
type |
|
|
id
|
id | string |
id |
|
|
type
|
type | string |
type |
|
|
id
|
id | string |
id (dipendente) |
|
|
type
|
type | string |
type |
|
|
id
|
id | string |
id (posizione) |
|
|
type
|
type | string |
type |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
data.id | string |
id |
|
type
|
data.type | string |
type |
|
agreement-status
|
data.attributes.agreements-status | string |
agreement-status |
|
full-name
|
data.attributes.full-name | string |
full-name |
|
posta elettronica
|
data.attributes.email | string |
posta elettronica |
|
inviter-name
|
data.attributes.inviter-name | string |
inviter-name |
|
inviter-email
|
data.attributes.inviter-email | string |
inviter-email |
|
previsto-ora di arrivo
|
data.attributes.expected-arrival-time | string |
previsto-ora di arrivo |
|
note private
|
data.attributes.private-notes | string |
note private |
|
arrivato
|
data.attributes.arrived | boolean |
arrivato |
|
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 |
|
guest aggiuntivi
|
data.attributes.additional-guests | integer |
guest aggiuntivi |
|
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 |
|
codice a matrice
|
data.attributes.qr-code | string |
codice a matrice |
|
qr-code-sent-at
|
data.attributes.qr-code-sent-at | string |
qr-code-sent-at |
|
preregistrazione completata
|
data.attributes.preregistration-complete | string |
preregistrazione completata |
|
status
|
data.attributes.approval-status.status | string |
status |
|
approvato automaticamente
|
data.attributes.approval-status.auto-approved | boolean |
approvato automaticamente |
|
report
|
data.attributes.approval-status.report | array of object |
report |
|
risultato
|
data.attributes.approval-status.report.result | string |
risultato |
|
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 |
|
intestazione
|
data.attributes.approval-status.report.messages.failure.header | string |
intestazione |
|
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 |
|
imparentato
|
data.relationships.platform-jobs.links.related | string |
imparentato |
|
incluso
|
included | array of object |
incluso |
|
id
|
included.id | string |
id |
|
type
|
included.type | string |
type |
|
nome
|
included.attributes.name | string |
nome |
|
stesso
|
links.self | string |
stesso |
Aggiungere un filtro blocklist
Richiesta POST per aggiungere un filtro blocklist
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
aliases
|
aliases | array of |
aliases |
|
|
descrizione
|
description | string |
descrizione |
|
|
messaggi di posta elettronica
|
emails | array of string |
messaggi di posta elettronica |
|
|
full-name
|
full-name | string |
full-name |
|
|
parola chiave
|
keyword | string |
parola chiave |
|
|
altre parole chiave
|
other-keywords | array of |
altre parole chiave |
|
|
reason
|
reason | string |
reason |
|
|
numeri di telefono
|
phone-numbers | array of |
numeri di telefono |
|
|
type
|
type | string |
type |
|
|
id
|
id | string |
id (posizione) |
|
|
type
|
type | string |
type |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
data.id | string |
id |
|
type
|
data.type | string |
type |
|
stesso
|
data.links.self | string |
stesso |
|
aliases
|
data.attributes.aliases | array of |
aliases |
|
descrizione
|
data.attributes.description | string |
descrizione |
|
messaggi di posta elettronica
|
data.attributes.emails | array of string |
messaggi di posta elettronica |
|
full-name
|
data.attributes.full-name | string |
full-name |
|
parola chiave
|
data.attributes.keyword | string |
parola chiave |
|
altre parole chiave
|
data.attributes.other-keywords | array of |
altre parole chiave |
|
numeri di telefono
|
data.attributes.phone-numbers | array of |
numeri di telefono |
|
Originale
|
data.attributes.photo.original | string |
Originale |
|
pollice
|
data.attributes.photo.thumb | string |
pollice |
|
reason
|
data.attributes.reason | string |
reason |
|
creato da
|
data.attributes.created-by | string |
creato da |
|
stesso
|
data.relationships.location.links.self | string |
stesso |
|
imparentato
|
data.relationships.location.links.related | string |
imparentato |
|
stesso
|
data.relationships.user.links.self | string |
stesso |
|
imparentato
|
data.relationships.user.links.related | string |
imparentato |
Creare inviti
Si tratta della richiesta POST per creare un invito
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Content-Type
|
Content-Type | string |
Content-Type |
|
|
full-name
|
full-name | string |
full-name |
|
|
posta elettronica
|
string |
posta elettronica |
||
|
inviter-name
|
inviter-name | string |
inviter-name |
|
|
previsto-ora di arrivo
|
expected-arrival-time | string |
previsto-ora di arrivo |
|
|
regola ricorrente
|
recurring-rule | string |
regola ricorrente |
|
|
rrule-until
|
rrule-until | string |
rrule-until |
|
|
note private
|
private-notes | string |
note private |
|
|
been-here-before
|
been-here-before | boolean |
been-here-before |
|
|
guest aggiuntivi
|
additional-guests | integer |
guest aggiuntivi |
|
|
skip-guest-notification
|
skip-guest-notification | boolean |
skip-guest-notification |
|
|
agreement-status
|
agreements-status | string |
agreement-status |
|
|
place-id
|
place-id | string |
place-id |
|
|
flow-name
|
flow-name | string |
flow-name |
|
|
group-name
|
group-name | string |
group-name |
|
|
arrivato
|
arrived | boolean |
arrivato |
|
|
stato approvazione
|
approval-status | string |
stato approvazione |
|
|
field
|
field | string |
field |
|
|
value
|
value | string |
value |
|
|
type
|
type | string |
type |
|
|
id
|
id | string |
id (dipendente) |
|
|
type
|
type | string |
type |
|
|
id
|
id | string |
id (posizione) |
|
|
type
|
type | string |
type |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
data.id | string |
id |
|
type
|
data.type | string |
type |
|
stesso
|
data.links.self | string |
stesso |
|
guest aggiuntivi
|
data.attributes.additional-guests | integer |
guest aggiuntivi |
|
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 |
|
risultato
|
data.attributes.approval-status.report.result | string |
risultato |
|
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 |
|
intestazione
|
data.attributes.approval-status.report.messages.failure.header | string |
intestazione |
|
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 |
|
posta elettronica
|
data.attributes.email | string |
posta elettronica |
|
previsto-ora di arrivo
|
data.attributes.expected-arrival-time | string |
previsto-ora di arrivo |
|
previsto-orario di partenza
|
data.attributes.expected-departure-time | string |
previsto-orario di partenza |
|
full-name
|
data.attributes.full-name | string |
full-name |
|
guest-updated-at
|
data.attributes.guest-updated-at | string |
guest-updated-at |
|
è presigned
|
data.attributes.is-presigned | boolean |
è 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 |
|
note private
|
data.attributes.private-notes | string |
note private |
|
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 |
|
creato da
|
data.attributes.created-from | string |
creato da |
|
arrivato
|
data.attributes.arrived | boolean |
arrivato |
|
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 |
|
stesso
|
data.relationships.attendee.links.self | string |
stesso |
|
imparentato
|
data.relationships.attendee.links.related | string |
imparentato |
|
stesso
|
data.relationships.creator.links.self | string |
stesso |
|
imparentato
|
data.relationships.creator.links.related | string |
imparentato |
|
stesso
|
data.relationships.employee.links.self | string |
stesso |
|
imparentato
|
data.relationships.employee.links.related | string |
imparentato |
|
type
|
data.relationships.employee.data.type | string |
type |
|
id
|
data.relationships.employee.data.id | string |
id |
|
stesso
|
data.relationships.entry.links.self | string |
stesso |
|
imparentato
|
data.relationships.entry.links.related | string |
imparentato |
|
type
|
data.relationships.entry.data.type | object |
type |
|
id
|
data.relationships.entry.data.id | string |
id |
|
stesso
|
data.relationships.flow.links.self | string |
stesso |
|
imparentato
|
data.relationships.flow.links.related | string |
imparentato |
|
type
|
data.relationships.flow.data.type | string |
type |
|
id
|
data.relationships.flow.data.id | string |
id |
|
stesso
|
data.relationships.location.links.self | string |
stesso |
|
imparentato
|
data.relationships.location.links.related | string |
imparentato |
|
type
|
data.relationships.location.data.type | string |
type |
|
id
|
data.relationships.location.data.id | string |
id |
|
stesso
|
data.relationships.platform-jobs.links.self | string |
stesso |
|
imparentato
|
data.relationships.platform-jobs.links.related | string |
imparentato |
Ottenere flussi
Richiesta GET per recuperare informazioni sui flussi per la posizione.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
filter[location]
|
filter[location] | integer |
filter[location] |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
data
|
data | array of object |
data |
|
id
|
data.id | string |
id |
|
type
|
data.type | string |
type |
|
stesso
|
data.links.self | string |
stesso |
|
guest aggiuntivi
|
data.attributes.additional-guests | boolean |
guest aggiuntivi |
|
minuti di disconnesso automatico
|
data.attributes.auto-sign-out-minutes | string |
minuti di disconnesso automatico |
|
disconnessa automaticamente a mezzanotte
|
data.attributes.auto-sign-out-at-midnight | boolean |
disconnessa automaticamente a mezzanotte |
|
badge abilitato
|
data.attributes.badge-enabled | boolean |
badge abilitato |
|
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 |
|
nome
|
data.attributes.name | string |
nome |
|
posizione
|
data.attributes.position | integer |
posizione |
|
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 |
|
stesso
|
data.relationships.agreement-page.links.self | string |
stesso |
|
imparentato
|
data.relationships.agreement-page.links.related | string |
imparentato |
|
stesso
|
data.relationships.badge.links.self | string |
stesso |
|
imparentato
|
data.relationships.badge.links.related | string |
imparentato |
|
stesso
|
data.relationships.location.links.self | string |
stesso |
|
imparentato
|
data.relationships.location.links.related | string |
imparentato |
|
stesso
|
data.relationships.photo-page.links.self | string |
stesso |
|
imparentato
|
data.relationships.photo-page.links.related | string |
imparentato |
|
stesso
|
data.relationships.sign-in-field-page.links.self | string |
stesso |
|
imparentato
|
data.relationships.sign-in-field-page.links.related | string |
imparentato |
|
stesso
|
data.relationships.summary-page.links.self | string |
stesso |
|
imparentato
|
data.relationships.summary-page.links.related | string |
imparentato |
|
totale
|
meta.total | integer |
totale |
|
primo
|
links.first | string |
primo |
|
ultimo
|
links.last | string |
ultimo |
Ottenere gli inviti
Richiesta GET per recuperare le informazioni sull'invito in base al filtro.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
filter[location]
|
filter[location] | integer |
filter[location] |
|
|
filter[date]
|
filter[date] | string |
filter[date] |
|
|
Accettare
|
Accept | string |
Accettare |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
data
|
data | array of object |
data |
|
id
|
data.id | string |
id |
|
type
|
data.type | string |
type |
|
stesso
|
data.links.self | string |
stesso |
|
guest aggiuntivi
|
data.attributes.additional-guests | integer |
guest aggiuntivi |
|
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 |
|
risultato
|
data.attributes.approval-status.report.result | string |
risultato |
|
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 |
|
intestazione
|
data.attributes.approval-status.report.messages.failure.header | string |
intestazione |
|
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 |
|
posta elettronica
|
data.attributes.email | string |
posta elettronica |
|
previsto-ora di arrivo
|
data.attributes.expected-arrival-time | string |
previsto-ora di arrivo |
|
previsto-orario di partenza
|
data.attributes.expected-departure-time | string |
previsto-orario di partenza |
|
full-name
|
data.attributes.full-name | string |
full-name |
|
guest-updated-at
|
data.attributes.guest-updated-at | string |
guest-updated-at |
|
è presigned
|
data.attributes.is-presigned | boolean |
è 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 |
|
note private
|
data.attributes.private-notes | string |
note private |
|
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 |
|
creato da
|
data.attributes.created-from | string |
creato da |
|
place_id
|
data.attributes.locality.place_id | string |
place_id |
|
place-id
|
data.attributes.locality.place-id | string |
place-id |
|
arrivato
|
data.attributes.arrived | boolean |
arrivato |
|
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 |
|
convalidato
|
data.attributes.attested | string |
convalidato |
|
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 |
|
stesso
|
data.relationships.attendee.links.self | string |
stesso |
|
imparentato
|
data.relationships.attendee.links.related | string |
imparentato |
|
stesso
|
data.relationships.creator.links.self | string |
stesso |
|
imparentato
|
data.relationships.creator.links.related | string |
imparentato |
|
stesso
|
data.relationships.employee.links.self | string |
stesso |
|
imparentato
|
data.relationships.employee.links.related | string |
imparentato |
|
type
|
data.relationships.employee.data.type | string |
type |
|
id
|
data.relationships.employee.data.id | string |
id |
|
stesso
|
data.relationships.entry.links.self | string |
stesso |
|
imparentato
|
data.relationships.entry.links.related | string |
imparentato |
|
type
|
data.relationships.entry.data.type | string |
type |
|
id
|
data.relationships.entry.data.id | string |
id |
|
stesso
|
data.relationships.flow.links.self | string |
stesso |
|
imparentato
|
data.relationships.flow.links.related | string |
imparentato |
|
type
|
data.relationships.flow.data.type | string |
type |
|
id
|
data.relationships.flow.data.id | string |
id |
|
stesso
|
data.relationships.location.links.self | string |
stesso |
|
imparentato
|
data.relationships.location.links.related | string |
imparentato |
|
type
|
data.relationships.location.data.type | string |
type |
|
id
|
data.relationships.location.data.id | string |
id |
|
stesso
|
data.relationships.platform-jobs.links.self | string |
stesso |
|
imparentato
|
data.relationships.platform-jobs.links.related | string |
imparentato |
|
totale
|
meta.total | integer |
totale |
|
primo
|
links.first | string |
primo |
|
next
|
links.next | string |
next |
|
ultimo
|
links.last | string |
ultimo |
Ottenere i filtri dell'elenco di blocchi
Richiesta GET per recuperare i filtri dell'elenco di blocchi.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
filter[company]
|
filter[company] | integer |
filter[company] |
|
|
Content-Type
|
Content-Type | string |
Content-Type |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
data
|
data | array of object |
data |
|
id
|
data.id | string |
id |
|
type
|
data.type | string |
type |
|
stesso
|
data.links.self | string |
stesso |
|
aliases
|
data.attributes.aliases | array of |
aliases |
|
descrizione
|
data.attributes.description | string |
descrizione |
|
messaggi di posta elettronica
|
data.attributes.emails | array of string |
messaggi di posta elettronica |
|
full-name
|
data.attributes.full-name | string |
full-name |
|
parola chiave
|
data.attributes.keyword | string |
parola chiave |
|
altre parole chiave
|
data.attributes.other-keywords | array of string |
altre parole chiave |
|
numeri di telefono
|
data.attributes.phone-numbers | array of |
numeri di telefono |
|
Originale
|
data.attributes.photo.original | string |
Originale |
|
pollice
|
data.attributes.photo.thumb | string |
pollice |
|
reason
|
data.attributes.reason | string |
reason |
|
image-url
|
data.attributes.image-url | string |
image-url |
|
external-id
|
data.attributes.external-id | string |
external-id |
|
creato da
|
data.attributes.created-by | string |
creato da |
|
stesso
|
data.relationships.location.links.self | string |
stesso |
|
imparentato
|
data.relationships.location.links.related | string |
imparentato |
|
stesso
|
data.relationships.user.links.self | string |
stesso |
|
imparentato
|
data.relationships.user.links.related | string |
imparentato |
|
totale
|
meta.total | integer |
totale |
Ottenere informazioni aziendali
Recuperare informazioni relative all'azienda (GET)
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Accettare
|
Accept | string |
Accettare |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
totale
|
meta.total | integer |
totale |
|
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 |
|
nome
|
data.attributes.name | string |
nome |
|
plan-intent
|
data.attributes.plan-intent | string |
plan-intent |
|
buy-intent
|
data.attributes.buy-intent | boolean |
buy-intent |
|
chiamata abilitata
|
data.attributes.call-enabled | boolean |
chiamata abilitata |
|
appletv-enabled
|
data.attributes.appletv-enabled | boolean |
appletv-enabled |
|
saml connesso
|
data.attributes.saml-connected | boolean |
saml connesso |
|
attivo
|
data.attributes.active | boolean |
attivo |
|
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 |
|
stesso
|
links.self | string |
stesso |
|
primo
|
links.first | string |
primo |
|
ultimo
|
links.last | string |
ultimo |
Ottenere l'elenco dei dipendenti
Richiesta GET per recuperare l'elenco dei dipendenti
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
data
|
data | array of object |
data |
|
id
|
data.id | string |
id |
|
type
|
data.type | string |
type |
|
stesso
|
data.links.self | string |
stesso |
|
cc-employee
|
data.attributes.cc-employee | boolean |
cc-employee |
|
company-id
|
data.attributes.company-id | integer |
company-id |
|
cancellato
|
data.attributes.deleted | boolean |
cancellato |
|
do-not-sync
|
data.attributes.do-not-sync | boolean |
do-not-sync |
|
posta elettronica
|
data.attributes.email | string |
posta elettronica |
|
hide-from-host-list
|
data.attributes.hide-from-host-list | boolean |
hide-from-host-list |
|
aggiunta manuale
|
data.attributes.manually-added | boolean |
aggiunta manuale |
|
manually-added-location-present
|
data.attributes.manually-added-location-present | boolean |
manually-added-location-present |
|
nome
|
data.attributes.name | string |
nome |
|
numero di telefono
|
data.attributes.phone-number | string |
numero di telefono |
|
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 |
|
stesso
|
data.relationships.company.links.self | string |
stesso |
|
imparentato
|
data.relationships.company.links.related | string |
imparentato |
|
stesso
|
data.relationships.user.links.self | string |
stesso |
|
imparentato
|
data.relationships.user.links.related | string |
imparentato |
|
stesso
|
data.relationships.assistants.links.self | string |
stesso |
|
imparentato
|
data.relationships.assistants.links.related | string |
imparentato |
|
stesso
|
data.relationships.bosses.links.self | string |
stesso |
|
imparentato
|
data.relationships.bosses.links.related | string |
imparentato |
|
stesso
|
data.relationships.employee-locations.links.self | string |
stesso |
|
imparentato
|
data.relationships.employee-locations.links.related | string |
imparentato |
|
stesso
|
data.relationships.locations.links.self | string |
stesso |
|
imparentato
|
data.relationships.locations.links.related | string |
imparentato |
|
totale
|
meta.total | integer |
totale |
|
primo
|
links.first | string |
primo |
|
ultimo
|
links.last | string |
ultimo |
Ottenere le posizioni
Richiesta GET per il recupero dei percorsi
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Accettare
|
Accept | string |
Accettare |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
data
|
data | array of object |
data |
|
id
|
data.id | string |
id |
|
type
|
data.type | string |
type |
|
stesso
|
data.links.self | string |
stesso |
|
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 |
|
disconnessa automaticamente a mezzanotte
|
data.attributes.auto-sign-out-at-midnight | boolean |
disconnessa automaticamente a mezzanotte |
|
minuti di disconnesso automatico
|
data.attributes.auto-sign-out-minutes | string |
minuti di disconnesso automatico |
|
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-registrazione abilitata
|
data.attributes.pre-registration-required-enabled | boolean |
pre-registrazione abilitata |
|
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 |
|
nome
|
data.attributes.name | string |
nome |
|
printer-notifications-enabled
|
data.attributes.printer-notifications-enabled | boolean |
printer-notifications-enabled |
|
più lingue abilitate
|
data.attributes.multiple-languages-enabled | boolean |
più lingue abilitate |
|
impostazioni locali abilitate
|
data.attributes.enabled-locales | array of |
impostazioni locali abilitate |
|
state
|
data.attributes.state | string |
state |
|
timezone
|
data.attributes.timezone | string |
timezone |
|
formato zip
|
data.attributes.zip | string |
formato zip |
|
media-mensile-visitatori
|
data.attributes.average-monthly-visitors | float |
media-mensile-visitatori |
|
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 |
|
stesso
|
data.relationships.company.links.self | string |
stesso |
|
imparentato
|
data.relationships.company.links.related | string |
imparentato |
|
stesso
|
data.relationships.device-config.links.self | string |
stesso |
|
imparentato
|
data.relationships.device-config.links.related | string |
imparentato |
|
stesso
|
data.relationships.gdpr-configuration.links.self | string |
stesso |
|
imparentato
|
data.relationships.gdpr-configuration.links.related | string |
imparentato |
|
stesso
|
data.relationships.printer.links.self | string |
stesso |
|
imparentato
|
data.relationships.printer.links.related | string |
imparentato |
|
stesso
|
data.relationships.devices.links.self | string |
stesso |
|
imparentato
|
data.relationships.devices.links.related | string |
imparentato |
|
stesso
|
data.relationships.employees.links.self | string |
stesso |
|
imparentato
|
data.relationships.employees.links.related | string |
imparentato |
|
stesso
|
data.relationships.fallback-contacts.links.self | string |
stesso |
|
imparentato
|
data.relationships.fallback-contacts.links.related | string |
imparentato |
|
stesso
|
data.relationships.flows.links.self | string |
stesso |
|
imparentato
|
data.relationships.flows.links.related | string |
imparentato |
|
stesso
|
data.relationships.locations-setup-guide-steps.links.self | string |
stesso |
|
imparentato
|
data.relationships.locations-setup-guide-steps.links.related | string |
imparentato |
|
stesso
|
data.relationships.printers.links.self | string |
stesso |
|
imparentato
|
data.relationships.printers.links.related | string |
imparentato |
|
stesso
|
data.relationships.printer-contacts.links.self | string |
stesso |
|
imparentato
|
data.relationships.printer-contacts.links.related | string |
imparentato |
|
totale
|
meta.total | integer |
totale |
|
primo
|
links.first | string |
primo |
|
ultimo
|
links.last | string |
ultimo |
Ottenere una voce
Richiesta GET per recuperare informazioni su una singola voce.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
entry_id
|
entry_id | True | string |
entry_id |
|
filter[location]
|
filter[location] | integer |
filter[location] |
|
|
Accettare
|
Accept | string |
Accettare |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
data.id | string |
id |
|
type
|
data.type | string |
type |
|
full-name
|
data.attributes.full-name | string |
full-name |
|
posta elettronica
|
data.attributes.email | string |
posta elettronica |
|
ospitante
|
data.attributes.host | string |
ospitante |
|
host-email
|
data.attributes.host-email | string |
host-email |
|
note private
|
data.attributes.private-notes | string |
note private |
|
signed-in-at
|
data.attributes.signed-in-at | string |
signed-in-at |
|
device-session-uuid
|
data.attributes.device-session-uuid | string |
device-session-uuid |
|
accesso tramite
|
data.attributes.signed-in-via | string |
accesso tramite |
|
signed-in-by
|
data.attributes.signed-in-by | string |
signed-in-by |
|
disconnesso tramite
|
data.attributes.signed-out-via | string |
disconnesso tramite |
|
disconnesso da
|
data.attributes.signed-out-by | string |
disconnesso da |
|
grande
|
data.attributes.thumbnails.large | string |
grande |
|
piccolo
|
data.attributes.thumbnails.small | string |
piccolo |
|
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 |
|
il recapito
|
data.attributes.is-delivery | boolean |
il recapito |
|
accordo rifiutato
|
data.attributes.agreement-refused | boolean |
accordo rifiutato |
|
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 |
|
stato approvazione
|
data.attributes.approval-status | string |
stato approvazione |
|
stato push
|
data.attributes.push-status | string |
stato push |
|
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 |
|
imparentato
|
data.relationships.previous-entries.links.related | string |
imparentato |
|
imparentato
|
data.relationships.platform-jobs.links.related | string |
imparentato |
|
stesso
|
links.self | string |
stesso |
Ottieni un invito
Richiesta GET per recuperare informazioni su un singolo invito.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
invite_id
|
invite_id | True | string |
invite_id |
|
Accettare
|
Accept | string |
Accettare |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
data.id | string |
id |
|
type
|
data.type | string |
type |
|
full-name
|
data.attributes.full-name | string |
full-name |
|
posta elettronica
|
data.attributes.email | string |
posta elettronica |
|
inviter-name
|
data.attributes.inviter-name | string |
inviter-name |
|
previsto-ora di arrivo
|
data.attributes.expected-arrival-time | string |
previsto-ora di arrivo |
|
note private
|
data.attributes.private-notes | string |
note private |
|
arrivato
|
data.attributes.arrived | boolean |
arrivato |
|
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 |
|
guest aggiuntivi
|
data.attributes.additional-guests | integer |
guest aggiuntivi |
|
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 |
|
stato approvazione
|
data.attributes.approval-status | string |
stato approvazione |
|
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 |
|
incluso
|
included | array of object |
incluso |
|
id
|
included.id | string |
id |
|
type
|
included.type | string |
type |
|
full-name
|
included.attributes.full-name | string |
full-name |
|
posta elettronica
|
included.attributes.email | string |
posta elettronica |
|
numero di telefono
|
included.attributes.phone-number | string |
numero di telefono |
|
avatar
|
included.attributes.avatar | string |
avatar |
|
created-at
|
included.attributes.created-at | string |
created-at |
|
posta elettronica abilitata
|
included.attributes.email-enabled | boolean |
posta elettronica abilitata |
|
sms abilitato
|
included.attributes.sms-enabled | boolean |
sms abilitato |
|
chiamata abilitata
|
included.attributes.call-enabled | string |
chiamata abilitata |
|
Slack abilitato
|
included.attributes.slack-enabled | boolean |
Slack abilitato |
|
hipchat-enabled
|
included.attributes.hipchat-enabled | boolean |
hipchat-enabled |
|
push abilitato
|
included.attributes.push-enabled | boolean |
push abilitato |
|
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 |
|
imparentato
|
included.relationships.location-roles.links.related | string |
imparentato |
|
imparentato
|
included.relationships.company-roles.links.related | string |
imparentato |
|
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 |
|
stesso
|
links.self | string |
stesso |
Trigger
| trigger Invite-Created |
Attivare un'azione in MS Flow quando viene creato un invito envoy. |
trigger Invite-Created
Attivare un'azione in MS Flow quando viene creato un invito envoy.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
token
|
token | string |
token |