Calendly (предварительная версия)
Соединитель Calendly позволяет автоматизировать запланированные события, повысить производительность и оптимизировать эффективность с помощью автоматизированных рабочих процессов.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Поддержка calendly |
| URL | https://help.calendly.com/hc/en-us |
| Адрес электронной почты | support@calendly.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Calendly |
| Website | https://calendly.com |
| Политика конфиденциальности | https://calendly.com/privacy |
| Категории | Продуктивность |
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Персональный токен доступа | securestring | Личный маркер доступа для этого API | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Получение типа события |
Возвращает сведения о указанном типе события. |
| Получение типов событий |
Возвращает все типы событий, связанные с вашей организацией. |
| Создание приглашения без отображения |
Помечает приглашение как "Нет шоу". |
| Удаление приглашения без отображения |
Отмена маркировки приглашения как "Нет шоу" |
Получение типа события
Возвращает сведения о указанном типе события.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип события UUID
|
uuid | True | string |
UUID запрашиваемого типа события |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
resource
|
resource | EventType |
Получение типов событий
Возвращает все типы событий, связанные с вашей организацией.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Active
|
active | boolean |
Возвращает только активные типы событий, если значение true, только неактивное, если значение false, или все типы событий, если этот параметр опущен. |
|
|
Численность
|
count | integer |
Количество возвращаемых строк. |
|
|
Маркер страницы
|
page_token | string |
Маркер для передачи следующей или предыдущей части коллекции. |
|
|
Управляемый администратором
|
admin_managed | boolean |
Возвращает только управляемые администратором типы событий, если значение true, исключите управляемые администратором типы событий, если значение false, или включите все типы событий, если этот параметр опущен. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
коллекция
|
collection | array of EventType |
коллекция |
|
Число разбиения на страницы
|
pagination.count | integer |
Количество возвращаемых строк. |
|
URI следующей страницы
|
pagination.next_page | string |
URI для возврата следующей страницы упорядоченного списка ("null" означает, что дополнительные результаты недоступны). |
|
URI предыдущей страницы
|
pagination.previous_page | string |
URI для возврата предыдущей страницы упорядоченного списка ("null" означает, что дополнительные результаты недоступны). |
|
Следующий маркер страницы
|
pagination.next_page_token | string |
Маркер для возврата следующей страницы упорядоченного списка (null) означает, что дополнительные результаты недоступны. |
|
Предыдущий маркер страницы
|
pagination.previous_page_token | string |
Маркер для возврата предыдущей страницы упорядоченного списка ("null" указывает, что дополнительные результаты недоступны). |
Создание приглашения без отображения
Помечает приглашение как "Нет шоу".
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Универсальный код ресурса (URI) "Пригласить"
|
invitee | True | string |
Универсальный код ресурса (URI) приглашения, помеченного как no Show для запланированного события |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Нет URI show
|
resource.uri | string |
Каноническая ссылка (уникальный идентификатор) для без отображения |
|
Универсальный код ресурса (URI) "Пригласить"
|
resource.invitee | string |
Каноническая ссылка (уникальный идентификатор) для связанного приглашения |
|
Создано в
|
resource.created_at | string |
Момент, когда не было создано шоу |
Удаление приглашения без отображения
Отмена маркировки приглашения как "Нет шоу"
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Приглашение без отображения UUID
|
uuid | True | string |
UUID приглашения, запись которого не отображается |
Возвращаемое значение
Нет успешного удаления show
- 204
- string
Триггеры
| Создание подписки на веб-перехватчик (отправка формы маршрутизации) |
Создайте подписку веб-перехватчика для организации, которая активируется при отправке формы маршрутизации. |
| Создание подписки на веб-перехватчик (Приглашение) |
Создайте подписку веб-перехватчика для организации, которая активируется при планировании или отмене события. |
Создание подписки на веб-перехватчик (отправка формы маршрутизации)
Создайте подписку веб-перехватчика для организации, которая активируется при отправке формы маршрутизации.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
events
|
events | True | array of string |
events |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Веб-перехватчик создан в
|
created_at | string |
Момент создания веб-перехватчика (например, "2020-01-02T03:04:05.678123Z"). |
|
Универсальный код ресурса (URI) создателя веб-перехватчика
|
created_by | string |
Ссылка на пользователя, создавшего подписку веб-перехватчика. |
|
Событие веб-перехватчика
|
event | string |
Событие, вызвавшее пожар веб-перехватчика. |
|
URI отправки форм маршрутизации
|
payload.uri | string |
Каноническая ссылка (уникальный идентификатор) для отправки формы маршрутизации. |
|
URI формы маршрутизации
|
payload.routing_form | string |
URI формы маршрутизации, связанной с отправкой. |
|
questions_and_answers
|
payload.questions_and_answers | array of object |
questions_and_answers |
|
Вопрос UUID
|
payload.questions_and_answers.question_uuid | string |
Уникальный идентификатор для вопроса формы маршрутизации. |
|
Question
|
payload.questions_and_answers.question | string |
Имя вопроса (в формате, доступном для чтения человеком). |
|
Ответ
|
payload.questions_and_answers.answer | string |
Ответ, предоставленный респондентом при отправке формы. |
|
Кампания UTM
|
payload.tracking.utm_campaign | string |
Параметр UTM, используемый для отслеживания кампании. |
|
Источник UTM
|
payload.tracking.utm_source | string |
Параметр UTM, определяющий источник (платформа, в которой происходит трафик). |
|
Средний UTM
|
payload.tracking.utm_medium | string |
Параметр UTM, определяющий тип входных данных (например, стоимость на щелчка (CPC), социальные медиа, филиал или QR-код. |
|
Содержимое UTM
|
payload.tracking.utm_content | string |
Параметр отслеживания содержимого UTM. |
|
Термин UTM
|
payload.tracking.utm_term | string |
Параметр UTM, используемый для отслеживания ключевого слова. |
|
Salesforce UUID
|
payload.tracking.salesforce_uuid | string |
Уникальный идентификатор записи Salesforce. |
|
Тип результата
|
payload.result.type | string |
Указывает, приводит ли отправка формы маршрутизации к пользовательскому сообщению, типу события или внешнему URL-адресу. |
|
Универсальный код ресурса (URI) для отправки
|
payload.submitter | string |
Ссылка на ресурс "Пригласить" при отправке формы маршрутизации приводит к запланированному собранию. |
|
Тип отправителя
|
payload.submitter_type | string |
Тип ресурса респондента, который отправил форму и запланировал собрание. |
|
Отправка формы маршрутизации, созданная в
|
payload.created_at | string |
Момент отправки формы маршрутизации. |
|
Обновлена отправка формы маршрутизации
|
payload.updated_at | string |
Момент последнего обновления отправки формы маршрутизации. |
Создание подписки на веб-перехватчик (Приглашение)
Создайте подписку веб-перехватчика для организации, которая активируется при планировании или отмене события.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
events
|
events | True | array of string |
events |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Веб-перехватчик создан в
|
created_at | string |
Момент создания веб-перехватчика (например, "2020-01-02T03:04:05.678123Z"). |
|
Универсальный код ресурса (URI) создателя веб-перехватчика
|
created_by | string |
Ссылка на пользователя, создавшего подписку веб-перехватчика. |
|
Событие веб-перехватчика
|
event | string |
Событие, вызвавшее пожар веб-перехватчика. |
|
URL-адрес события отмены
|
payload.cancel_url | string |
Ссылка на отмену события для приглашения. |
|
Приглашение создано в
|
payload.created_at | string |
Момент создания события (например, "2020-01-02T03:04:05.678123Z"). |
|
Приглашение по электронной почте
|
payload.email | string |
Адрес электронной почты приглашения. |
|
Универсальный код ресурса (URI) событий
|
payload.event | string |
Ссылка на событие. |
|
Имя приглашения
|
payload.name | string |
Имя приглашений. |
|
Пригласить имя
|
payload.first_name | string |
Первое имя приглашенного, забронировать событие при настройке типа события для использования отдельных полей для имени и фамилии. Null, если тип события настроен для использования одного поля для имени. |
|
Пригласить фамилию
|
payload.last_name | string |
Фамилия приглашенного, забронировать событие, когда тип события настроен для использования отдельных полей для имени и фамилии. Null, если тип события настроен для использования одного поля для имени. |
|
Новый универсальный код ресурса (URI) приглашения
|
payload.new_invitee | string |
Ссылка на новое приглашение после переплана. |
|
Старый универсальный код ресурса (URI) приглашения
|
payload.old_invitee | string |
Ссылка на старый экземпляр Invitee, который был перепланирован. |
|
Коллекция ответов приглашенного на вопросы о форме подтверждения бронирования событий
|
payload.questions_and_answers | array of object |
Коллекция ответов приглашенного на вопросы о форме подтверждения резервирования событий. |
|
Question
|
payload.questions_and_answers.question | string |
Вопрос о форме резервирования приглашений. |
|
Ответ
|
payload.questions_and_answers.answer | string |
Ответ приглашенного на вопрос. |
|
Позиция вопроса
|
payload.questions_and_answers.position | number |
Позиция вопроса относительно других лиц в форме резервирования. |
|
URL-адрес события перепланировки
|
payload.reschedule_url | string |
Ссылка на изменение расписания события для приглашений. |
|
Пригласить Перепланирован?
|
payload.rescheduled | boolean |
Перенесено |
|
Состояние приглашения
|
payload.status | string |
статус |
|
Пригласить номер напоминания о тексте
|
payload.text_reminder_number | string |
text_reminder_number |
|
Пригласить часовой пояс
|
payload.timezone | string |
timezone |
|
Кампания UTM
|
payload.tracking.utm_campaign | string |
Параметр UTM, используемый для отслеживания кампании. |
|
Источник UTM
|
payload.tracking.utm_source | string |
Параметр UTM, определяющий источник (платформа, в которой происходит трафик). |
|
Средний UTM
|
payload.tracking.utm_medium | string |
Параметр UTM, определяющий тип входных данных (например, стоимость на щелчка (CPC), социальные медиа, филиал или QR-код. |
|
Содержимое UTM
|
payload.tracking.utm_content | string |
Параметр отслеживания содержимого UTM. |
|
Термин UTM
|
payload.tracking.utm_term | string |
Параметр UTM, используемый для отслеживания ключевого слова. |
|
Salesforce UUID
|
payload.tracking.salesforce_uuid | string |
Уникальный идентификатор записи Salesforce. |
|
Универсальный код ресурса (URI) "Пригласить"
|
payload.uri | string |
Каноническая ссылка (уникальный идентификатор) для приглашения. |
|
URI отправки форм маршрутизации
|
payload.routing_form_submission | string |
Ссылка на отправку формы маршрутизации, которая перенаправила приглашение на страницу резервирования. |
|
scheduled_event
|
payload.scheduled_event | ScheduledEvent | |
|
отмена
|
payload.cancellation | Cancellation |
Предоставляет данные, относящиеся к отмене события |
|
уплата
|
payload.payment | Payment |
Пригласить платеж |
|
no_show
|
payload.no_show | NoShow |
Предоставляет данные, относящиеся к связанному no show for the Invitee. |
|
Подтверждение
|
payload.reconfirmation | Reconfirmation |
Предполагая, что повторное подтверждение включено для типа события, при запросе повторного подтверждения этот объект присутствует с |
Определения
ScheduledEvent
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Универсальный код ресурса (URI) событий
|
uri | uri |
Каноническая ссылка (уникальный идентификатор) для ресурса. |
|
Имя события
|
name | string |
Имя события. |
|
Состояние события
|
status | string |
Указывает, является ли событие активным или отмененным. |
|
Время начала события
|
start_time | date-time |
Момент начала события в формате UTC (например, "2020-01-02T03:04:05.678123Z"). |
|
Время окончания события
|
end_time | date-time |
Момент окончания события в формате UTC (например, "2020-01-02T03:04:05.678123Z") |
|
URI типа события
|
event_type | uri |
Тип события, связанный с этим событием |
|
location
|
location | Location |
Полиморфный базовый тип для расположения события, которое поддерживает Calendly |
|
Всего приглашений
|
invitees_counter.total | number |
Всего приглашений на событие, включая приглашения, отмененные |
|
Всего активных приглашений
|
invitees_counter.active | number |
Всего приглашений на событие, которое не отменено. |
|
Максимальное число приглашений событий
|
invitees_counter.limit | number |
Максимальное количество активных приглашений, которые могут забронировать событие. |
|
Событие, созданное в
|
created_at | date-time |
Момент создания события (например, "2020-01-02T03:04:05.678123Z") |
|
Событие обновлено по адресу
|
updated_at | date-time |
Момент последнего обновления события (например, "2020-01-02T03:04:05.678123Z") |
|
event_memberships
|
event_memberships | array of object |
Список членства в событиях |
|
Универсальный код ресурса (URI) члена события
|
event_memberships.user | uri |
Каноническая ссылка (уникальный идентификатор) для пользователя. |
|
Электронная почта участника события
|
event_memberships.user_email |
Адрес электронной почты пользователя. |
|
|
event_guests
|
event_guests | array of Guest |
Дополнительные пользователи, добавленные в событие приглашенным |
|
отмена
|
cancellation | Cancellation |
Предоставляет данные, относящиеся к отмене события |
|
Событие календаря
|
calendar_event | LegacyCalendarEvent |
Сведения о событии календаря от поставщика календаря. |
Отмена
Предоставляет данные, относящиеся к отмене события
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Отменено
|
canceled_by | string |
Имя человека, которого отменили. |
|
Причина отмены
|
reason | string |
Причина, по которой произошла отмена. |
|
Тип отмены
|
canceler_type | string |
Указывает, было ли отменено событие "Узел" или "Пригласить". |
Guest
Человек, которому приглашенный участник мероприятия
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Гостевая электронная почта события
|
Сообщение электронной почты гостя события. |
||
|
Гость события, созданное в
|
created_at | date-time |
Время создания гостя события. |
|
Гость событий обновлен по адресу
|
updated_at | date-time |
Время последнего обновления гостевого события. |
Местоположение
Полиморфный базовый тип для расположения события, которое поддерживает Calendly
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Тип расположения
|
type | string |
Указывает тип расположения события. |
|
Состояние веб-конференции
|
status | string |
Это поле относится только к типам расположения zoom_conference, webex_conference, google_conference, gotomeeting и microsoft_teams_conference расположения. |
|
URL-адрес собрания веб-конференции
|
join_url | uri |
Это поле относится только к типам расположения zoom_conference, webex_conference, google_conference, gotomeeting и microsoft_teams_conference расположения. |
|
Расположение события
|
location | string |
Это поле применяется только к типам outbound_call, inbound_call, физических, ask_invitee и пользовательских расположений. |
LegacyCalendarEvent
Сведения о событии календаря от поставщика календаря.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Тип события Calendly
|
kind | string |
Указывает поставщик календаря, к которому относится событие. |
|
Идентификатор события внешнего календаря
|
external_id | string |
Идентификатор, предоставленный поставщиком календаря для этого события календаря. |
Уплата
Пригласить платеж
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Внешний идентификатор оплаты
|
external_id | string |
Уникальный идентификатор для оплаты. |
|
Поставщик платежей
|
provider | string |
Поставщик платежей. |
|
Сумма оплаты
|
amount | float |
Сумма платежа. |
|
Валюта платежа
|
currency | string |
Формат валюты, в который входит платеж. |
|
Условия оплаты
|
terms | string |
Условия оплаты. |
|
Платеж успешно выполнен?
|
successful | boolean |
Указывает, был ли платеж успешно обработан. |
NoShow
Предоставляет данные, относящиеся к связанному no show for the Invitee.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Нет URI show
|
uri | string |
Каноническая ссылка (уникальный идентификатор) для без отображения |
|
Нет отображения, созданного в
|
created_at | date-time |
Момент, когда не было создано шоу. |
Тип события
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
URI типа события
|
uri | string |
Каноническая ссылка (уникальный идентификатор) для типа события. |
|
Имя типа события
|
name | string |
Имя типа события (в формате, доступном для чтения человеком). |
|
Active
|
active | boolean |
Указывает, является ли событие активным или нет. |
|
Метод Booking
|
booking_method | string |
Указывает, является ли тип события для опроса или мгновенного резервирования. |
|
Slug
|
slug | string |
Часть URL-адреса типа события, которая определяет определенную веб-страницу (в формате, доступном для чтения человеком). |
|
URL-адрес планирования
|
scheduling_url | string |
URL-адрес сайта планирования пользователя, в котором приглашает забронировать этот тип события. |
|
Продолжительность
|
duration | integer |
Длина сеансов, зарезервированных с этим типом события. |
|
Kind
|
kind | string |
Указывает, является ли тип события "solo" (принадлежит отдельному пользователю) или "группа". |
|
Тип пула
|
pooling_type | string |
Указывает, является ли тип события "циклическим перебором" (альтернативным между узлами) или "коллективным" (приглашения выбирают время, когда все участники доступны) или "null" (тип события не учитывает доступность участников группы). |
|
Тип
|
type | string |
Указывает, является ли тип события AdhocEventType (нерегламентированным событием) или StandardEventType (стандартный тип события). |
|
Цвет
|
color | string |
Шестнадцатеричное значение цвета страницы планирования типа события. |
|
Создано в
|
created_at | string |
Момент создания типа события (например, "2020-01-02T03:04:05.678123Z"). |
|
Обновлено в
|
updated_at | string |
Момент последнего обновления типа события (например, "2020-01-02T03:04:05.678123Z"). |
|
Внутренняя заметка
|
internal_note | string |
Содержимое заметки, которая может быть связана с типом события. |
|
Описание (обычный)
|
description_plain | string |
Описание типа события (в неформатируемом тексте). |
|
Описание (HTML)
|
description_html | string |
Описание типа события (отформатировано с помощью HTML). |
|
Тип профиля
|
profile.type | string |
Указывает, принадлежит ли профиль пользователю (отдельному) или "команде". |
|
Имя профиля
|
profile.name | string |
Доступное для чтения имя профиля пользователя, связанного с типом события. |
|
Универсальный код ресурса (URI владельца профиля)
|
profile.owner | string |
Уникальная ссылка на пользователя, связанного с профилем. |
|
Секрет
|
secret | boolean |
Указывает, скрыт ли тип события на главной странице планирования владельца. |
|
Удалено в
|
deleted_at | string |
Момент удаления типа события (например, "2020-01-02T03:04:05.678123Z"). |
|
Управляемый администратором
|
admin_managed | boolean |
Указывает, управляется ли этот тип события администратором организации. |
|
custom_questions
|
custom_questions | array of object |
custom_questions |
|
Настраиваемое имя вопроса
|
custom_questions.name | string |
имя |
|
Настраиваемый тип вопроса
|
custom_questions.type | string |
type |
|
Настраиваемое положение вопроса
|
custom_questions.position | integer |
позиция |
|
Настраиваемый вопрос включен
|
custom_questions.enabled | boolean |
enabled |
|
Обязательный настраиваемый вопрос
|
custom_questions.required | boolean |
required |
|
Выбор настраиваемых ответов на вопрос
|
custom_questions.answer_choices | array of string |
answer_choices |
|
Включить другое
|
custom_questions.include_other | boolean |
include_other |
Подтверждение
Предполагая, что повторное подтверждение включено для типа события, при запросе повторного подтверждения этот объект присутствует с created_at тем, что отражается при отправке уведомления о повторном подтверждении. После повторного confirmed_at подтверждения атрибута атрибут изменится на null метку времени, которая отражается при выполнении действия.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Повторное подтверждение, созданное в
|
created_at | date-time |
После создания подтверждения. |
|
Приглашение подтверждено по адресу
|
confirmed_at | date-time |
Когда приглашенный подтвердил свою посещаемость. |