Calendly (Pré-visualização)
O conector da Calendly permite automatizar eventos agendados, aumentando a produtividade e otimizando a eficiência por meio de fluxos de trabalho automatizados.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte Calendly |
| URL | https://help.calendly.com/hc/en-us |
| support@calendly.com |
| Metadados do conector | |
|---|---|
| Editora | Calendly |
| Sítio Web | https://calendly.com |
| Política de privacidade | https://calendly.com/privacy |
| Categorias | Produtividade |
A criar uma ligação
O conector suporta os seguintes tipos de autenticação:
| Predefinição | 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.
Esta conexão não é compartilhável. Se o aplicativo avançado 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 |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Criar No Show de Convidados |
Marca um convidado como um não comparecimento. |
| Excluir convidado No Show |
Desfaz a marcação de um convidado como No Show |
| Obter tipo de evento |
Retorna informações sobre um tipo de evento especificado. |
| Obter tipos de eventos |
Retorna todos os tipos de eventos associados à sua organização. |
Criar No Show de Convidados
Marca um convidado como um não comparecimento.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
URI do convidado
|
invitee | True | string |
URI do convidado que está sendo marcado como No Show para um evento agendado |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
No Show URI
|
resource.uri | string |
Referência canônica (identificador exclusivo) para o não comparecimento |
|
URI do convidado
|
resource.invitee | string |
Referência canônica (identificador exclusivo) para o convidado associado |
|
Criado em
|
resource.created_at | string |
O momento em que o no show foi criado |
Excluir convidado No Show
Desfaz a marcação de um convidado como No Show
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Invitee No Show UUID
|
uuid | True | string |
UUID do convidado cujo registro No Show está sendo removido |
Devoluções
No Show excluído com sucesso
- 204
- string
Obter tipo de evento
Retorna informações sobre um tipo de evento especificado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Tipo de evento UUID
|
uuid | True | string |
UUID do tipo de evento que está sendo solicitado |
Devoluções
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
recurso
|
resource | EventType |
Obter tipos de eventos
Retorna todos os tipos de eventos associados à sua organização.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Active
|
active | boolean |
Retorne somente tipos de eventos ativos se verdadeiros, somente inativos se falsos ou todos os tipos de eventos se esse parâmetro for omitido. |
|
|
Contar
|
count | integer |
O número de linhas a serem retornadas. |
|
|
Token da página
|
page_token | string |
O token a ser passado para obter a próxima parte ou a parte anterior da coleção. |
|
|
Administrador Gerenciado
|
admin_managed | boolean |
Retorne somente tipos de eventos gerenciados por admin se true, exclua tipos de eventos gerenciados admin se false ou inclua todos os tipos de eventos se esse parâmetro for omitido. |
Devoluções
| Name | 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 página seguinte
|
pagination.next_page | string |
URI para retornar a próxima página de uma lista ordenada ("null" indica que não há resultados adicionais disponíveis). |
|
URI da página anterior
|
pagination.previous_page | string |
URI para retornar a página anterior de uma lista ordenada ("null" indica que não há resultados adicionais disponíveis). |
|
Token da próxima página
|
pagination.next_page_token | string |
Token para retornar a próxima página de uma lista ordenada ("null" 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 ("null" indica que não há resultados adicionais disponíveis). |
Acionadores
| Criar Assinatura Webhook (Envio de Formulário de Roteamento) |
Crie uma Assinatura Webhook para uma Organização que é acionada quando um formulário de roteamento é enviado. |
| Criar Subscrição Webhook (Convidado) |
Crie uma Assinatura Webhook para uma Organização que é acionada quando um evento é agendado ou cancelado. |
Criar Assinatura Webhook (Envio de Formulário de Roteamento)
Crie uma Assinatura Webhook para uma Organização que é acionada quando um formulário de roteamento é enviado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
events
|
events | True | array of string |
events |
Devoluções
| Name | 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"). |
|
Webhook Creator URI
|
created_by | string |
Uma referência ao usuário que criou a assinatura do webhook. |
|
Evento Webhook
|
event | string |
O evento que causou o disparo 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. |
|
Question
|
payload.questions_and_answers.question | string |
Nome da pergunta (em formato legível por humanos). |
|
Resposta
|
payload.questions_and_answers.answer | string |
Resposta dada pelo requerido aquando da apresentação do formulário. |
|
Campanha UTM
|
payload.tracking.utm_campaign | string |
O parâmetro UTM usado para rastrear uma campanha. |
|
Fonte UTM
|
payload.tracking.utm_source | string |
O parâmetro UTM que identifica a origem (plataforma de origem do tráfego). |
|
UTM Médio
|
payload.tracking.utm_medium | string |
O parâmetro UTM que identifica o tipo de entrada (por exemplo, Custo Por Clique (CPC), mídia social, afiliado ou código QR). |
|
Conteúdo UTM
|
payload.tracking.utm_content | string |
Parâmetro de rastreamento de conteúdo UTM. |
|
Termo UTM
|
payload.tracking.utm_term | string |
O parâmetro UTM usado para rastrear palavra-chave. |
|
Salesforce UUID
|
payload.tracking.salesforce_uuid | string |
O identificador exclusivo de registro do 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 transmitente
|
payload.submitter | string |
A referência ao recurso Convidado ao rotear o envio do formulário resulta em uma reunião agendada. |
|
Tipo de transmitente
|
payload.submitter_type | string |
Tipo de recurso do 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 do 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. |
Criar Subscrição Webhook (Convidado)
Crie uma Assinatura Webhook para uma Organização que é acionada quando um evento é agendado ou cancelado.
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
events
|
events | True | array of string |
events |
Devoluções
| Name | 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"). |
|
Webhook Creator URI
|
created_by | string |
Uma referência ao usuário que criou a assinatura do webhook. |
|
Evento Webhook
|
event | string |
O evento que causou o disparo do webhook. |
|
Cancelar URL do evento
|
payload.cancel_url | string |
Link para cancelar o evento para o convidado. |
|
Convidado criado em
|
payload.created_at | string |
O momento em que o evento foi criado (por exemplo, "2020-01-02T03:04:05.678123Z"). |
|
E-mail de convidado
|
payload.email | string |
O endereço de e-mail do convidado. |
|
URI do evento
|
payload.event | string |
Uma referência ao evento. |
|
Nome do convidado
|
payload.name | string |
O nome do convidado. |
|
Nome do convidado
|
payload.first_name | string |
O primeiro nome do convidado que reservou o evento quando o tipo de evento está configurado para usar campos separados para nome e sobrenome. Nulo quando o tipo de evento é configurado para usar um único campo para nome. |
|
Sobrenome do convidado
|
payload.last_name | string |
O sobrenome do convidado que reservou o evento quando o tipo de evento está 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 convidado
|
payload.new_invitee | string |
Link para novo convidado, após reagendamento. |
|
URI de convidado antigo
|
payload.old_invitee | string |
Referência à instância antiga do Invitee que foi reagendada. |
|
Uma coleção de respostas do convidado a perguntas no formulário de confirmação de reserva do evento
|
payload.questions_and_answers | array of object |
Uma coleção de respostas do convidado a perguntas no formulário de confirmação de reserva do evento. |
|
Question
|
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 à pergunta. |
|
Posição da pergunta
|
payload.questions_and_answers.position | number |
A posição da pergunta em relação a outras no formulário de reserva. |
|
Reagendar URL do Evento
|
payload.reschedule_url | string |
Link para reagendar o evento para o convidado. |
|
Convidado reagendado?
|
payload.rescheduled | boolean |
reagendado |
|
Status do convidado
|
payload.status | string |
estado |
|
Número de lembrete de texto do convidado
|
payload.text_reminder_number | string |
text_reminder_number |
|
Fuso horário do convidado
|
payload.timezone | string |
timezone |
|
Campanha UTM
|
payload.tracking.utm_campaign | string |
O parâmetro UTM usado para rastrear uma campanha. |
|
Fonte UTM
|
payload.tracking.utm_source | string |
O parâmetro UTM que identifica a origem (plataforma de origem do tráfego). |
|
UTM Médio
|
payload.tracking.utm_medium | string |
O parâmetro UTM que identifica o tipo de entrada (por exemplo, Custo Por Clique (CPC), mídia social, afiliado ou código QR). |
|
Conteúdo UTM
|
payload.tracking.utm_content | string |
Parâmetro de rastreamento de conteúdo UTM. |
|
Termo UTM
|
payload.tracking.utm_term | string |
O parâmetro UTM usado para rastrear palavra-chave. |
|
Salesforce UUID
|
payload.tracking.salesforce_uuid | string |
O identificador exclusivo de registro do Salesforce. |
|
URI do convidado
|
payload.uri | string |
Referência canônica (identificador único) 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 convidado 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 |
Pagamento por convite |
|
no_show
|
payload.no_show | NoShow |
Fornece dados referentes ao não comparecimento associado para o convidado. |
|
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 |
Definições
Evento agendado
| Name | 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. |
|
Estado do Evento
|
status | string |
Indica se o evento está "ativo" ou "cancelado". |
|
Hora de início do evento
|
start_time | date-time |
O momento em que o evento foi programado para começar no horário UTC (por exemplo, "2020-01-02T03:04:05.678123Z"). |
|
Hora de Fim do Evento
|
end_time | date-time |
O momento em que o evento estava programado 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 |
|
localização
|
location | Location |
O tipo de base polimórfica para um local de evento que o Calendly suporta |
|
Total de convidados
|
invitees_counter.total | number |
Total de convidados para um evento, incluindo convidados que cancelaram |
|
Total de convidados ativos
|
invitees_counter.active | number |
Total de convidados para um evento que não foram cancelados. |
|
Convidados do Evento Max
|
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 membros do evento |
|
URI de Membro do Evento
|
event_memberships.user | uri |
Referência canônica (identificador exclusivo) para o usuário. |
|
E-mail do Membro do Evento
|
event_memberships.user_email |
O endereço de e-mail 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 |
|
Calendário de Eventos
|
calendar_event | LegacyCalendarEvent |
Informações sobre o evento de calendário do provedor de calendário. |
Cancelamento
Fornece dados relativos ao cancelamento do Evento
| Name | 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 "Anfitrião" ou "Convidado". |
Guest
Um indivíduo que um convidado convidou para ser um participante convidado de um evento
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
E-mail do convidado do evento
|
O e-mail 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órfica para um local de evento que o Calendly suporta
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tipo de localização
|
type | string |
Indica o tipo de local do evento. |
|
Estado da Conferência Web
|
status | string |
Este campo aplica-se apenas aos tipos de localização zoom_conference, webex_conference, google_conference, gotomeeting e microsoft_teams_conference. |
|
URL da Reunião de Conferência Web
|
join_url | uri |
Este campo aplica-se apenas aos tipos de localização zoom_conference, webex_conference, google_conference, gotomeeting e microsoft_teams_conference. |
|
Local do Evento
|
location | string |
Este campo aplica-se apenas aos tipos de localização outbound_call, inbound_call, física, ask_invitee e personalizada. |
LegacyCalendarEvent
Informações sobre o evento de calendário do provedor de calendário.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Tipo de evento Calendly
|
kind | string |
Indica o provedor de calendário ao qual o evento pertence. |
|
ID do Evento do Calendário Externo
|
external_id | string |
A id fornecida pelo provedor de calendário para este evento de calendário. |
Pagamento
Pagamento por convite
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Pagamento ID Externo
|
external_id | string |
Identificador único 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 se encontra. |
|
Condições de Pagamento
|
terms | string |
Condições de pagamento. |
|
Pagamento bem-sucedido?
|
successful | boolean |
Indica se o pagamento foi processado com êxito. |
NoShow
Fornece dados referentes ao não comparecimento associado para o convidado.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
No Show URI
|
uri | string |
Referência canônica (identificador exclusivo) para o não comparecimento |
|
No Show Criado em
|
created_at | date-time |
O momento em que o no show foi criado. |
Tipo de Evento
| Name | 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 de Reserva
|
booking_method | string |
Indica se o tipo de evento é para uma pesquisa ou uma Reserva rápida. |
|
Campo Dinâmico
|
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 onde os convidados reservam esse tipo de evento. |
|
Duração
|
duration | integer |
A duração das sessões reservadas com este tipo de evento. |
|
Variante
|
kind | string |
Indica se o tipo de evento é "solo" (pertence a um usuário individual) ou "grupo". |
|
Tipo de pool
|
pooling_type | string |
Indica se o tipo de evento é "round robin" (alterna entre anfitriões) ou "coletivo" (os convidados escolhem um horário em que todos os participantes estão disponíveis) ou "null" (o tipo de evento não considera a disponibilidade de participantes de um grupo). |
|
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 |
O momento em que o tipo de evento foi criado (por exemplo, "2020-01-02T03:04:05.678123Z"). |
|
Atualizado em
|
updated_at | string |
O momento em que o tipo de evento foi atualizado pela última vez (por exemplo, "2020-01-02T03:04:05.678123Z"). |
|
Nota Interna
|
internal_note | string |
Conteúdo de uma nota 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" (indivíduo) ou "equipe". |
|
Nome do perfil
|
profile.name | string |
Nome legível por humanos 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. |
|
Segredo
|
secret | boolean |
Indica se o tipo de evento está oculto na página principal de agendamento do proprietário. |
|
Suprimido em
|
deleted_at | string |
O 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 personalizada
|
custom_questions.type | string |
tipo |
|
Posição da pergunta personalizada
|
custom_questions.position | integer |
posição |
|
Pergunta personalizada ativada
|
custom_questions.enabled | boolean |
enabled |
|
Pergunta personalizada necessária
|
custom_questions.required | boolean |
required |
|
Opções personalizadas de resposta a perguntas
|
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 for reconfirmado, o atributo mudará de um carimbo confirmed_at de null data/hora que reflete quando ele tomou uma ação.
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Reconfirmação criada em
|
created_at | date-time |
Quando a reconfirmação foi criada. |
|
Convidado confirmado em
|
confirmed_at | date-time |
Quando o Convidado confirmou a sua presença. |