Calendly (versão prévia)
O conector da Calendly permite automatizar eventos agendados, aumentando a produtividade e otimizando a eficiência por meio de fluxos de trabalho automatizados.
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 | Suporte ao Calendly |
| URL | https://help.calendly.com/hc/en-us |
| support@calendly.com |
| Metadados do conector | |
|---|---|
| Publicador | Calendly |
| Site | https://calendly.com |
| Política de privacidade | https://calendly.com/privacy |
| Categorias | Produtividade |
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 |
|---|---|---|---|
| Token de acesso pessoal | secureString | O Token de Acesso Pessoal para esta api | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Criar Convite Sem Mostrar |
Marca um Convite como um Não Show. |
| Excluir Convite Sem Mostrar |
Desfazer marcando um Convite como um Não Show |
| Obter tipo de evento |
Retorna informações sobre um tipo de evento especificado. |
| Obter tipos de evento |
Retorna todos os Tipos de Eventos associados à sua organização. |
Criar Convite Sem Mostrar
Marca um Convite como um Não Show.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Convidar URI
|
invitee | True | string |
URI do convidado que está sendo marcado como Nenhum Show para um evento agendado |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
URI Sem Mostrar
|
resource.uri | string |
Referência canônica (identificador exclusivo) para o no show |
|
Convidar URI
|
resource.invitee | string |
Referência canônica (identificador exclusivo) para o Invitee associado |
|
Criado em
|
resource.created_at | string |
O momento em que o não show foi criado |
Excluir Convite Sem Mostrar
Desfazer marcando um Convite como um Não Show
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Convidar UUID sem mostrar
|
uuid | True | string |
UUID do convidado cujo registro No Show está sendo removido |
Retornos
Nenhum Show excluído com êxito
- 204
- string
Obter tipo de evento
Retorna informações sobre um tipo de evento especificado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
UUID do tipo de evento
|
uuid | True | string |
UUID do tipo de evento que está sendo solicitado |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
recurso
|
resource | EventType |
Obter tipos de evento
Retorna todos os Tipos de Eventos associados à sua organização.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Active
|
active | boolean |
Retornará somente tipos de evento ativos se verdadeiros, apenas inativos se false ou todos os tipos de evento se esse parâmetro for omitido. |
|
|
Contagem
|
count | integer |
O número de linhas a serem retornadas. |
|
|
Token de Página
|
page_token | string |
O token a ser passado para obter a próxima parte ou anterior da coleção. |
|
|
Administrador Gerenciado
|
admin_managed | boolean |
Retorne apenas os tipos de evento gerenciados do administrador se verdadeiro, exclua os tipos de evento gerenciados pelo administrador se for false ou inclua todos os tipos de evento se esse parâmetro for omitido. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
coleção
|
collection | array of EventType |
coleção |
|
Contagem de paginação
|
pagination.count | integer |
O número de linhas a serem retornadas. |
|
URI da Próxima Página
|
pagination.next_page | string |
URI para retornar a próxima página de uma lista ordenada ("nulo" indica que nenhum resultado adicional está disponível). |
|
URI da página anterior
|
pagination.previous_page | string |
URI para retornar a página anterior de uma lista ordenada ("nulo" indica que nenhum resultado adicional está disponível). |
|
Token da Próxima Página
|
pagination.next_page_token | string |
Token para retornar a próxima página de uma lista ordenada ("nulo" indica que nenhum resultado adicional está disponível). |
|
Token de Página Anterior
|
pagination.previous_page_token | string |
Token para retornar a página anterior de uma lista ordenada ("nulo" indica que nenhum resultado adicional está disponível). |
Gatilhos
| Criar assinatura do Webhook (Convite) |
Crie uma assinatura do Webhook para uma organização que é disparada quando um evento é agendado ou cancelado. |
| Criar assinatura do Webhook (envio de formulário de roteamento) |
Crie uma assinatura do Webhook para uma organização que é disparada quando um formulário de roteamento é enviado. |
Criar assinatura do Webhook (Convite)
Crie uma assinatura do Webhook para uma organização que é disparada quando um evento é agendado ou cancelado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
events
|
events | True | array of string |
events |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Webhook criado em
|
created_at | string |
O momento em que o webhook foi criado (por exemplo, "2020-01-02T03:04:05.678123Z"). |
|
URI do Criador do Webhook
|
created_by | string |
Uma referência ao usuário que criou a assinatura do webhook. |
|
Evento webhook
|
event | string |
O evento que causou o incêndio do webhook. |
|
Cancelar URL do Evento
|
payload.cancel_url | string |
Link para cancelar o evento para o convidado. |
|
Convidar criado em
|
payload.created_at | string |
O momento em que o evento foi criado (por exemplo, "2020-01-02T03:04:05.678123Z"). |
|
Convidar Email
|
payload.email | string |
O endereço de email do convidado. |
|
URI do evento
|
payload.event | string |
Uma referência ao evento. |
|
Nome do Convite
|
payload.name | string |
O nome do convidado. |
|
Nome do convidado
|
payload.first_name | string |
O nome do convidado que reservou o evento quando o tipo de evento é configurado para usar campos separados para nome e sobrenome. Nulo quando o tipo de evento é configurado para usar um único campo para nome. |
|
Convidar sobrenome
|
payload.last_name | string |
O sobrenome do convidado que reservou o evento quando o tipo de evento é configurado para usar campos separados para nome e sobrenome. Nulo quando o tipo de evento é configurado para usar um único campo para nome. |
|
Novo URI de Convite
|
payload.new_invitee | string |
Link para o novo convite, após reagendar. |
|
URI do Convite Antigo
|
payload.old_invitee | string |
Referência à instância antiga do Invitee que foi reagendada. |
|
Uma coleção de respostas do convidado a perguntas sobre o formulário de confirmação de reserva de eventos
|
payload.questions_and_answers | array of object |
Uma coleção de respostas do convidado a perguntas sobre o formulário de confirmação de reserva de eventos. |
|
Pergunta
|
payload.questions_and_answers.question | string |
Uma pergunta no formulário de reserva do convidado. |
|
Resposta
|
payload.questions_and_answers.answer | string |
A resposta do convidado para a pergunta. |
|
Posição da pergunta
|
payload.questions_and_answers.position | number |
A posição da questão em relação a outras pessoas no formulário de reserva. |
|
Reagendar URL de Evento
|
payload.reschedule_url | string |
Link para reagendar o evento para o convidado. |
|
Convidar reagendado?
|
payload.rescheduled | boolean |
Remarcado |
|
Status do Convite
|
payload.status | string |
status |
|
Convidar número de lembrete de texto
|
payload.text_reminder_number | string |
text_reminder_number |
|
Convidar fuso horário
|
payload.timezone | string |
timezone |
|
Campanha UTM
|
payload.tracking.utm_campaign | string |
O parâmetro UTM usado para acompanhar uma campanha. |
|
Origem UTM
|
payload.tracking.utm_source | string |
O parâmetro UTM que identifica a origem (plataforma na qual o tráfego se origina). |
|
Médio UTM
|
payload.tracking.utm_medium | string |
O parâmetro UTM que identifica o tipo de entrada (por exemplo, CUSTO por Clique (CPC), mídia social, afiliada ou código QR). |
|
Conteúdo UTM
|
payload.tracking.utm_content | string |
Parâmetro de acompanhamento de conteúdo UTM. |
|
Termo UTM
|
payload.tracking.utm_term | string |
O parâmetro UTM usado para acompanhar a palavra-chave. |
|
Salesforce UUID
|
payload.tracking.salesforce_uuid | string |
O identificador exclusivo do registro salesforce. |
|
Convidar URI
|
payload.uri | string |
Referência canônica (identificador exclusivo) para o convidado. |
|
URI de envio de formulário de roteamento
|
payload.routing_form_submission | string |
Referência a um envio de formulário de roteamento que redirecionou o convite para uma página de reserva. |
|
scheduled_event
|
payload.scheduled_event | ScheduledEvent | |
|
cancelamento
|
payload.cancellation | Cancellation |
Fornece dados relativos ao cancelamento do Evento |
|
pagamento
|
payload.payment | Payment |
Convidar pagamento |
|
no_show
|
payload.no_show | NoShow |
Fornece dados relativos ao não show associado para o Invitee. |
|
Reconfirmação
|
payload.reconfirmation | Reconfirmation |
Supondo que a reconfirmação esteja habilitada para o tipo de evento, quando a reconfirmação é solicitada, esse objeto está presente com um |
Criar assinatura do Webhook (envio de formulário de roteamento)
Crie uma assinatura do Webhook para uma organização que é disparada quando um formulário de roteamento é enviado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
events
|
events | True | array of string |
events |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Webhook criado em
|
created_at | string |
O momento em que o webhook foi criado (por exemplo, "2020-01-02T03:04:05.678123Z"). |
|
URI do Criador do Webhook
|
created_by | string |
Uma referência ao usuário que criou a assinatura do webhook. |
|
Evento webhook
|
event | string |
O evento que causou o incêndio do webhook. |
|
URI de envio de formulário de roteamento
|
payload.uri | string |
Referência canônica (identificador exclusivo) para o envio do formulário de roteamento. |
|
URI do formulário de roteamento
|
payload.routing_form | string |
O URI do formulário de roteamento associado ao envio. |
|
questions_and_answers
|
payload.questions_and_answers | array of object |
questions_and_answers |
|
Pergunta UUID
|
payload.questions_and_answers.question_uuid | string |
Identificador exclusivo para a pergunta do formulário de roteamento. |
|
Pergunta
|
payload.questions_and_answers.question | string |
Nome da pergunta (em formato legível por humanos). |
|
Resposta
|
payload.questions_and_answers.answer | string |
Resposta fornecida pelo entrevistado quando o formulário foi enviado. |
|
Campanha UTM
|
payload.tracking.utm_campaign | string |
O parâmetro UTM usado para acompanhar uma campanha. |
|
Origem UTM
|
payload.tracking.utm_source | string |
O parâmetro UTM que identifica a origem (plataforma na qual o tráfego se origina). |
|
Médio UTM
|
payload.tracking.utm_medium | string |
O parâmetro UTM que identifica o tipo de entrada (por exemplo, CUSTO por Clique (CPC), mídia social, afiliada ou código QR). |
|
Conteúdo UTM
|
payload.tracking.utm_content | string |
Parâmetro de acompanhamento de conteúdo UTM. |
|
Termo UTM
|
payload.tracking.utm_term | string |
O parâmetro UTM usado para acompanhar a palavra-chave. |
|
Salesforce UUID
|
payload.tracking.salesforce_uuid | string |
O identificador exclusivo do registro salesforce. |
|
Tipo de resultado
|
payload.result.type | string |
Indica se o envio do formulário de roteamento resultou em uma mensagem personalizada, tipo de evento ou URL externa. |
|
URI do remetente
|
payload.submitter | string |
A referência ao recurso Invitee ao rotear o envio de formulário resulta em uma reunião agendada. |
|
Tipo de enviador
|
payload.submitter_type | string |
Tipo do recurso respondente que enviou o formulário e agendou uma reunião. |
|
Envio de formulário de roteamento criado em
|
payload.created_at | string |
No momento em que o formulário de roteamento foi enviado. |
|
Envio de formulário de roteamento atualizado em
|
payload.updated_at | string |
O momento em que o envio do formulário de roteamento foi atualizado pela última vez. |
Definições
ScheduledEvent
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
URI do evento
|
uri | uri |
Referência canônica (identificador exclusivo) para o recurso. |
|
Nome do Evento
|
name | string |
O nome do evento. |
|
Status do evento
|
status | string |
Indica se o evento está "ativo" ou "cancelado". |
|
Hora de início do evento
|
start_time | date-time |
No momento em que o evento foi agendado para começar no horário UTC (por exemplo, "2020-01-02T03:04:05.678123Z"). |
|
Hora de término do evento
|
end_time | date-time |
O momento em que o evento foi agendado para terminar no horário UTC (por exemplo, "2020-01-02T03:04:05.678123Z") |
|
URI do tipo de evento
|
event_type | uri |
O tipo de evento associado a este evento |
|
local
|
location | Location |
O tipo de base polimórfico para um local de evento compatível com Calendly |
|
Total de Convites
|
invitees_counter.total | number |
Total de convites para um evento, incluindo convites que cancelaram |
|
Total de Convites Ativos
|
invitees_counter.active | number |
Total de convites para um evento que não foi cancelado. |
|
Convites máximos de evento
|
invitees_counter.limit | number |
Número máximo de convidados ativos que podem reservar o evento. |
|
Evento criado em
|
created_at | date-time |
O momento em que o evento foi criado (por exemplo, "2020-01-02T03:04:05.678123Z") |
|
Evento atualizado em
|
updated_at | date-time |
O momento em que o evento foi atualizado pela última vez (por exemplo, "2020-01-02T03:04:05.678123Z") |
|
event_memberships
|
event_memberships | array of object |
Lista de associações de eventos |
|
URI do membro do evento
|
event_memberships.user | uri |
Referência canônica (identificador exclusivo) para o usuário. |
|
Email do membro do evento
|
event_memberships.user_email |
O endereço de email do usuário. |
|
|
event_guests
|
event_guests | array of Guest |
Pessoas adicionais adicionadas a um evento por um convidado |
|
cancelamento
|
cancellation | Cancellation |
Fornece dados relativos ao cancelamento do Evento |
|
Evento calendário
|
calendar_event | LegacyCalendarEvent |
Informações sobre o evento de calendário do provedor de calendário. |
Cancelamento
Fornece dados relativos ao cancelamento do Evento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Cancelado por
|
canceled_by | string |
Nome da pessoa que cancelou. |
|
Motivo do cancelamento
|
reason | string |
Motivo pelo qual o cancelamento ocorreu. |
|
Tipo de cancelador
|
canceler_type | string |
Indica se o evento foi cancelado pelo "Host" ou "Convite". |
Guest
Um indivíduo que um convidado convidou para ser um participante convidado para um evento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Email de convidado do evento
|
O email do convidado do evento. |
||
|
Convidado do evento criado em
|
created_at | date-time |
Hora em que o convidado do evento foi criado. |
|
Convidado do evento atualizado em
|
updated_at | date-time |
Hora em que o convidado do evento foi atualizado pela última vez. |
Localização
O tipo de base polimórfico para um local de evento compatível com Calendly
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tipo de local
|
type | string |
Indica o tipo de local do evento. |
|
Status da Conferência Web
|
status | string |
Esse campo só se aplica a tipos de localização zoom_conference, webex_conference, google_conference, gotomeeting e microsoft_teams_conference. |
|
URL da Reunião de Conferência Da Web
|
join_url | uri |
Esse campo só se aplica a tipos de localização zoom_conference, webex_conference, google_conference, gotomeeting e microsoft_teams_conference. |
|
Local do evento
|
location | string |
Esse campo só se aplica a tipos de localização outbound_call, inbound_call, físicos, ask_invitee e personalizados. |
LegacyCalendarEvent
Informações sobre o evento de calendário do provedor de calendário.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tipo de evento Calendly
|
kind | string |
Indica o provedor de calendário ao qual o evento pertence. |
|
ID de evento de calendário externo
|
external_id | string |
A ID fornecida do provedor de calendário para este evento de calendário. |
Pagamento
Convidar pagamento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID externa de pagamento
|
external_id | string |
Identificador exclusivo para o pagamento. |
|
Provedor de Pagamento
|
provider | string |
Provedor de pagamento. |
|
Valor do pagamento
|
amount | float |
O valor do pagamento. |
|
Moeda de pagamento
|
currency | string |
O formato de moeda em que o pagamento está. |
|
Condições de Pagamento
|
terms | string |
Termos do pagamento. |
|
Pagamento bem-sucedido?
|
successful | boolean |
Indica se o pagamento foi processado com êxito. |
NoShow
Fornece dados relativos ao não show associado para o Invitee.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
URI Sem Mostrar
|
uri | string |
Referência canônica (identificador exclusivo) para o no show |
|
No Show Created At
|
created_at | date-time |
O momento em que o show não foi criado. |
Tipo de Evento
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
URI do tipo de evento
|
uri | string |
Referência canônica (identificador exclusivo) para o tipo de evento. |
|
Nome do tipo de evento
|
name | string |
O nome do tipo de evento (em formato legível por humanos). |
|
Active
|
active | boolean |
Indica se o evento está ativo ou não. |
|
Método Booking
|
booking_method | string |
Indica se o tipo de evento é para uma votação ou uma reserva instantânea. |
|
Slug
|
slug | string |
A parte da URL do tipo de evento que identifica uma página da Web específica (em um formato legível por humanos). |
|
URL de agendamento
|
scheduling_url | string |
A URL do site de agendamento do usuário em que os convidados reservam esse tipo de evento. |
|
Duração
|
duration | integer |
O comprimento das sessões reservadas com esse tipo de evento. |
|
Variante
|
kind | string |
Indica se o tipo de evento é "solo" (pertence a um usuário individual) ou "grupo". |
|
Tipo de pooling
|
pooling_type | string |
Indica se o tipo de evento é "round robin" (alterna entre hosts) ou "coletivo" (os convidados escolhem uma hora em que todos os participantes estão disponíveis) ou "nulo" (o tipo de evento não considera a disponibilidade de um grupo de participantes). |
|
Tipo
|
type | string |
Indica se o tipo de evento é "AdhocEventType" (evento ad hoc) ou "StandardEventType" (tipo de evento padrão). |
|
Cor
|
color | string |
O valor de cor hexadecimal da página de agendamento do tipo de evento. |
|
Criado em
|
created_at | string |
No momento em que o tipo de evento foi criado (por exemplo, "2020-01-02T03:04:05.678123Z"). |
|
Atualizado em
|
updated_at | string |
No momento em que o tipo de evento foi atualizado pela última vez (por exemplo, "2020-01-02T03:04:05.678123Z"). |
|
Observação interna
|
internal_note | string |
Conteúdo de uma observação que pode estar associada ao tipo de evento. |
|
Descrição (simples)
|
description_plain | string |
A descrição do tipo de evento (em texto não formatado). |
|
Descrição (HTML)
|
description_html | string |
A descrição do tipo de evento (formatada com HTML). |
|
Tipo de perfil
|
profile.type | string |
Indica se o perfil pertence a um "usuário" (individual) ou "equipe". |
|
Nome do perfil
|
profile.name | string |
Nome legível para o perfil do usuário associado ao tipo de evento. |
|
URI do Proprietário do Perfil
|
profile.owner | string |
A referência exclusiva ao usuário associado ao perfil. |
|
Secret
|
secret | boolean |
Indica se o tipo de evento está oculto na página de agendamento principal do proprietário. |
|
Excluído em
|
deleted_at | string |
No momento em que o tipo de evento foi excluído (por exemplo, "2020-01-02T03:04:05.678123Z"). |
|
Administrador Gerenciado
|
admin_managed | boolean |
Indica se esse tipo de evento é gerenciado por um administrador da organização. |
|
custom_questions
|
custom_questions | array of object |
custom_questions |
|
Nome da pergunta personalizada
|
custom_questions.name | string |
nome |
|
Tipo de pergunta personalizado
|
custom_questions.type | string |
tipo |
|
Posição da pergunta personalizada
|
custom_questions.position | integer |
posição |
|
Pergunta personalizada habilitada
|
custom_questions.enabled | boolean |
enabled |
|
Pergunta personalizada necessária
|
custom_questions.required | boolean |
required |
|
Opções de resposta a perguntas personalizadas
|
custom_questions.answer_choices | array of string |
answer_choices |
|
Incluir Outros
|
custom_questions.include_other | boolean |
include_other |
Reconfirmação
Supondo que a reconfirmação esteja habilitada para o tipo de evento, quando a reconfirmação é solicitada, esse objeto está presente com um created_at que reflete quando a notificação de reconfirmação foi enviada. Depois que o convidado tiver confirmado novamente, o confirmed_at atributo mudará de para um carimbo de null data/hora que reflete quando eles tomaram medidas.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Confirmação criada em
|
created_at | date-time |
Quando a reconfirmação foi criada. |
|
Convidar confirmado em
|
confirmed_at | date-time |
Quando o Invitee confirmou sua presença. |