Calendly (預覽版)
Calendly 的連接器使您能夠自動化預定的活動,透過自動化工作流程提高生產力並優化效率。
此連接器適用於以下產品和區域:
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域, 但下列區域除外: - Azure Government 區域 - Azure 中國區域 - 美國國防部 (DoD) |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| Power Automate(自動化服務) | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 連絡人 | |
|---|---|
| 名稱 | Calendly 支持 |
| URL | https://help.calendly.com/hc/en-us |
| support@calendly.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | 日曆地 |
| 網站 | https://calendly.com |
| 隱私策略 | https://calendly.com/privacy |
| 類別 | 生產力 |
正在建立連線
連接器支援下列驗證類型:
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用:所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 個人存取令牌 | securestring | 此 API 的個人存取權杖 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 刪除受邀者未出現 |
撤銷將受邀者標記為未出現 |
| 取得事件類型 |
傳回指定事件類型的相關資訊。 |
| 取得事件類型 |
傳回與您的組織相關聯的所有事件型別。 |
| 建立受邀者未出現 |
將受邀者標記為未出現。 |
刪除受邀者未出現
撤銷將受邀者標記為未出現
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
受邀者未出現 UUID
|
uuid | True | string |
未出現記錄被移除的受邀者的 UUID |
傳回
No Show 已成功刪除
- 204
- string
取得事件類型
傳回指定事件類型的相關資訊。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
事件類型 UUID
|
uuid | True | string |
所要求事件型別的UUID |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
資源
|
resource | EventType |
取得事件類型
傳回與您的組織相關聯的所有事件型別。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
Active
|
active | boolean |
如果 true 則僅傳回作用中事件類型,如果 false,則僅傳回非作用中事件類型,如果省略此參數,則傳回所有事件類型。 |
|
|
Count
|
count | integer |
要傳回的列數。 |
|
|
頁面權杖
|
page_token | string |
要傳遞的權杖,以取得集合的下一個或上一個部分。 |
|
|
管理員管理
|
admin_managed | boolean |
如果為true,則僅傳回管理員管理的事件類型,如果為false,則排除管理員管理的事件類型,如果省略此參數,則包含所有事件類型。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
收藏
|
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 |
Token 以傳回排序清單的下一頁 (「null」表示沒有其他可用的結果)。 |
|
上一頁 代幣
|
pagination.previous_page_token | string |
傳回排序清單上一頁的權杖 (「null」表示沒有其他可用的結果)。 |
建立受邀者未出現
將受邀者標記為未出現。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
受邀者 URI
|
invitee | True | string |
在排程事件中標示為未出現的受邀者的 URI |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
未出現 URI
|
resource.uri | string |
未出現的規範參考(唯一標識符) |
|
受邀者 URI
|
resource.invitee | string |
相關聯受邀者的標準參考 (唯一識別碼) |
|
創建於
|
resource.created_at | string |
創造缺席的那一刻 |
觸發程序
| 建立 Webhook 訂閱 (受邀者) |
為組織建立 Webhook 訂閱,該訂閱會在排程或取消事件時觸發。 |
| 建立 Webhook 訂閱 (路由表單提交) |
為提交路由表單時觸發的組織建立Webhook訂閱。 |
建立 Webhook 訂閱 (受邀者)
為組織建立 Webhook 訂閱,該訂閱會在排程或取消事件時觸發。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
events
|
events | True | array of string |
events |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Webhook 建立於
|
created_at | string |
建立 Webhook 的時刻 (例如「2020-01-02T03:04:05.678123Z」)。 |
|
Webhook 建立者 URI
|
created_by | string |
建立 Webhook 訂用帳戶之使用者的參考。 |
|
Webhook 事件
|
event | string |
導致 Webhook 引發的事件。 |
|
取消事件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 |
參考已重新排程的舊受邀者執行個體。 |
|
受邀者對活動預訂確認表上問題的回答集合
|
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)、社交媒體、聯盟或二維碼)。 |
|
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 |
提供與受邀者相關未出現相關的資料。 |
|
再次確認
|
payload.reconfirmation | Reconfirmation |
假設已針對事件類型啟用重新確認,當要求重新確認時,此物件會與 一起出現, |
建立 Webhook 訂閱 (路由表單提交)
為提交路由表單時觸發的組織建立Webhook訂閱。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
events
|
events | True | array of string |
events |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Webhook 建立於
|
created_at | string |
建立 Webhook 的時刻 (例如「2020-01-02T03:04:05.678123Z」)。 |
|
Webhook 建立者 URI
|
created_by | string |
建立 Webhook 訂用帳戶之使用者的參考。 |
|
Webhook 事件
|
event | string |
導致 Webhook 引發的事件。 |
|
路由表單提交 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)、社交媒體、聯盟或二維碼)。 |
|
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 |
上次更新路由表單提交的時刻。 |
定義
預定活動
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
事件 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 |
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 |
來自行事曆提供者的行事曆事件相關資訊。 |
取消
提供與取消活動有關的數據
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
取消者
|
canceled_by | string |
取消人員的姓名。 |
|
取消原因
|
reason | string |
取消發生的原因。 |
|
取消器類型
|
canceler_type | string |
指出活動是否由「主持人」或「受邀者」取消。 |
Guest
受邀者邀請成為活動來賓出席者的個人
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
活動賓客電子郵件
|
活動來賓的電子郵件。 |
||
|
活動訪客建立於
|
created_at | date-time |
建立事件訪客的時間。 |
|
活動嘉賓更新於
|
updated_at | date-time |
事件來賓上次更新的時間。 |
地點
Calendly 支援之事件位置的多型基底類型
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
位置類型
|
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和自訂位置類型。 |
舊版日曆事件
來自行事曆提供者的行事曆事件相關資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Calendly 事件類型
|
kind | string |
指出事件所屬的行事曆提供者。 |
|
外部行事曆事件標識符
|
external_id | string |
行事曆提供者為此行事曆事件提供的識別碼。 |
付款
受邀者付款
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
付款外部ID
|
external_id | string |
付款的唯一標識碼。 |
|
付款提供者
|
provider | string |
付款提供者。 |
|
付款金額
|
amount | float |
付款金額。 |
|
付款貨幣
|
currency | string |
付款所採用的貨幣格式。 |
|
付款條件
|
terms | string |
付款條款。 |
|
付款成功?
|
successful | boolean |
指出付款是否已成功處理。 |
不顯示
提供與受邀者相關未出現相關的資料。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
未出現 URI
|
uri | string |
未出現的規範參考(唯一標識符) |
|
未創建的演出時間
|
created_at | date-time |
創造缺席的那一刻。 |
事件類型
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
事件類型 URI
|
uri | string |
事件類型的標準參考 (唯一識別碼)。 |
|
事件類型名稱
|
name | string |
事件類型名稱 (人類可讀的格式)。 |
|
Active
|
active | boolean |
指出事件是否處於作用中狀態。 |
|
預訂方式
|
booking_method | string |
指出活動類型是用於投票還是即時預訂。 |
|
動態資料欄位
|
slug | string |
事件型別 URL 中識別特定網頁的部分 (以人類可讀的格式)。 |
|
排程網址
|
scheduling_url | string |
受邀者預訂此活動類型的使用者排程網站的 URL。 |
|
持續時間
|
duration | integer |
使用此事件類型預訂的階段作業長度。 |
|
種類
|
kind | string |
指出事件類型是「單人」(屬於個別使用者)還是「群組」。 |
|
集區類型
|
pooling_type | string |
指出事件類型是「循環配置資源」(主持人之間輪流)還是「集體」(受邀者選擇所有參與者都有空的時間)或「空」(事件類型不考慮群組參與者的可用性)。 |
|
類型
|
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 |
型別 |
|
自訂問題位置
|
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 為反映他們採取動作的時間戳記。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
重新確認建立於
|
created_at | date-time |
建立重新確認的時間。 |
|
受邀者確認於
|
confirmed_at | date-time |
當受邀者確認出席時。 |