共用方式為

StaffCircle （預覽版）

StaffCircle 是一個員工成功平台，它將公司文化與績效管理相結合，即使在分佈式工作環境中也能創建高績效團隊。 StafffCircle 包括與您的能力框架相關的目標、評論、價值觀和反饋。 透過深入的洞察來推動參與度和績效。

此連接器適用於以下產品和區域：

服務 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）
連絡人​​
名稱 StaffCircle 支持
URL https://www.staffcircle.com/contact-us/
Email support@staffcircle.com
連接器中繼資料
Publisher 員工圈
網站 https://www.staffcircle.com/
隱私權原則 https://www.staffcircle.com/privacy-policy/
類別 傳達;人力資源

StaffCircle 通過改進績效管理、溝通和文化來幫助組織管理其遠程勞動力。 您可以連接到 StaffCircle 來管理您的 one2one 評論、績效目標、okrs、實時反饋、獎項和認可。 您可以執行各種操作，例如創建或更新績效目標、分配獎勵、創建文章和警報、更新用戶信息等等。

先決條件

若要使用此連接器，您必須有權存取 StaffCircle 帳戶。 StaffCircle 是付費訂閱計劃。 如果您無權訪問 StaffCircle 帳戶，您可以在 此處找到更多詳細信息。

如何取得認證

如果您有權存取 StaffCircle 帳戶，則您已經擁有開始使用此連接器所需的認證。 建立 StaffCircle 連接器的連線時，系統會提示您輸入使用者名稱和密碼。 任何 StaffCircle 帳戶憑證都可以在這裡使用。 請務必注意，聯結器將在所提供認證的內容中執行，這包括考慮安全性許可權。 這表示您必須確定您使用的 StaffCircle 帳戶具有正確的許可權，才能執行您在連接器中觸發的動作。

開始使用連接器

開始使用 StaffCircle 連接器非常簡單，您只需要一個 StaffCircle 帳戶。 您的使用者認證可用來建立與 StaffCircle 連接器的連線。 完成後，您可以使用連接器中定義的觸發器之一，從 StaffCircle 執行個體內發生的事件開始觸發自動化工作流程。

以下是一些範例工作流程

  • 當文章在 StaffCircle 中發布時觸發工作流程，並將有關文章的通知發送到 Slack 等聊天應用程序。
  • 當新員工新增至 StaffCircle 時觸發工作流程，並推動入職流程，其中可能包括與新員工的電子郵件等通訊。

StaffCircle 有許多 Webhook，這些 Webhook 並非全部在連接器中公開為觸發程式。 如果您找不到適合您需求的觸發器，請考慮查看我們的 Webhook。 我們的 Webhook 可以在 StaffCircle Web 應用程序的設置集成部分下找到。 您可以使用流程觸發程式「收到 HTTP 要求時」來產生 URL，該 URL 可提供給 StaffCircle Webhook 以觸發工作流程。

這類工作流程的範例是

  • 當員工提出假日請求時，請建立 Outlook 行事曆事件。

StaffCircle 提供了一系列行動來幫助改善企業內部的溝通和客觀管理。 “創建新警報”等操作可用於觸發跨 StaffCircle 支持的多個渠道發送消息，例如電子郵件、短信、MS Teams、應用內和推送通知。 這有助於讓您的團隊了解其他應用程式中發生的重要事件。

目標動作可用來自動追蹤KPI。 當事件發生在其他應用程式中時，例如贏得商機，您可以使用交易的價值來更新 StaffCircle 中設定的目標。

StaffCircle 提供了便利操作，例如“通過電子郵件獲取人員”，以幫助輕鬆地將員工鏈接到其他操作，例如“創建新任務”

Support

如果您在設定 StaffCircle 連接器時遇到困難，或需要滿足您業務需求的功能，請透過以下方式與我們聯絡： support@staffcircle.com

節流限制

名稱 呼叫 續約期間
每個連線的 API 呼叫 100 60 秒

動作

依範本建立新目標

使用目標範本建立新目標
建立新人員

建立人員
建立新工作

建立新任務並將其指派給使用者
建立新文章

創建一篇新文章，可以通過多種溝通渠道分發給 StaffCircle 用戶
建立新目標

建立新目標
建立新警示

創建一個新的警報，可以通過多種通信渠道分發給 StaffCircle 用戶
搜尋目標

搜尋目標
更新目標分數

使用新分數和描述更新目標
透過電子郵件取得人員

嘗試透過電子郵件尋找人員記錄

依範本建立新目標

作業識別碼：
CreateObjectiveByTemplate

使用目標範本建立新目標

參數

名稱 機碼 必要 類型 Description
目標範本
 objectiveTemplateId True integer

從目標範本建立新目標
開始日期
 startDate True date-time

從測量目標開始
結束日期
 endDate True date-time

目標的截止日期
人員電子郵件
 personEmail string

目標對象的電子郵件地址。 需要建立個人目標。 如果未提供部門或人員，則假設目標是公司目標
人員 ID
 personId integer

目標所針對人員的 ID。 需要建立個人目標。 如果未提供部門或人員，則假設目標是公司目標
部門名稱
 departmentName string

目標所在的部門名稱。 建立部門目標的必要條件。 如果未提供部門或人員，則假設目標是公司目標
部門識別碼
 departmentId integer

目標所在部門的 ID。 建立部門目標的必要條件。 如果未提供部門或人員，則假設目標是公司目標
經理電子郵件
 managerEmail string

負責追蹤目標的經理的電子郵件。 自動預設為人員或部門管理員。 如果人員或部門沒有經理或目標是公司目標，則為必要項目。 如果未提供管理員 ID ，則使用該 ID
Title
 title string

覆寫新目標的名稱。
Description
 description string

覆寫新目標的描述。
管理員 ID
 managerId integer

負責追蹤目標的經理。 自動預設為人員或部門管理員。 如果人員或部門沒有經理或目標是公司目標，則為必要項目。 如果未提供管理員電子郵件，則使用
公司目標標識碼
 companyObjectiveId integer

新建立目標所相關的公司目標的選擇性連結
部門目標識別碼
 departmentObjectiveId integer

新建立目標所關聯之部門目標的選用連結

傳回

名稱 路徑 類型 Description
目標標識碼
 id integer

已建立目標的識別碼

建立新人員

作業識別碼：
CreatePerson

建立人員

參數

名稱 機碼 必要 類型 Description
名字
 firstName True string

此人的名字
第二個名字
 secondName True string

此人的第二個名字
Email
 email True string

人員的工作電子郵件地址
行動裝置
 mobile True string

此人的手機號碼
出生日期
 dateOfBirth True date

此人的出生日期
開始日期
 startDate True string

該人的受僱時間
地址行 1
 addressLine1 string

此人住家地址的第一行
地址行 2
 addressLine2 string

此人的住家地址第二行
鎮
 town string

該人的居住城市
郵遞區號
 postCode string

此人的郵遞區號
縣名稱
 countyName string

該人的居住縣
國家名稱
 countryName string

該人的居住國家/地區
標題名稱
 titleName string

人員的頭銜
中間名
 middleName string

此人的中間名
個人 Email
 homeEmail string

此人的個人電子郵件地址
住家電話
 homeTelephone string

此人的住家電話號碼
標記
 tag string

可用於在整個 StaffCircle 平台中引用人員的標籤
經理電子郵件
 managerEmail string

人員的經理電子郵件地址。 這可用來將經理與人員連結
部門名稱
 departmentName string

人員所屬部門的名稱
角色名稱
 roleName string

人員的角色。 這可用來將角色連結至人員
被稱為
 knownAs string

此人喜歡被稱為
個人資料圖片網址
 avatarURL string

此人的個人資料圖片
標題 ID
 titleId integer

人員的頭銜
縣身份證
 countyId integer

該人的居住縣
國家/地區 ID
 countryId integer

該人的居住國家/地區
性別認同
 genderId integer

此人的性別識別碼
國籍 ID
 nationalityId integer

該人的國籍
種族 ID
 ethnicityId integer

該人的種族
婚姻狀況 ID
 maritalStatusId integer

該人的婚姻狀況
管理員 ID
 managerId integer

該人員的管理員識別碼（只能輸入管理員 ID 或管理員電子郵件）
部門識別碼
 departmentId integer

人員的部門識別碼（只能輸入部門 ID 或部門名稱）
角色 ID
 roleId integer

人員的就業角色識別碼（只能輸入角色 ID 或角色名稱）
站台識別碼
 mainSiteId integer

人員所屬的網站識別碼
緊急聯絡人同意書
 emergencyContactConsent boolean

緊急聯絡人是否同意儲存其詳細資料
緊急聯絡人姓名
 emergencyContactName string

此人的緊急聯絡人名稱
緊急聯絡人關係 ID
 emergencyRelationshipId integer

緊急聯絡人與人之間的關係
緊急聯絡電話
 emergencyContactTelephone string

該人的緊急聯絡人的電話號碼
緊急地址
 emergencyAddress string

人員緊急地址
近親姓名
 nextOfKinName string

此人的近親姓名
近親關係 ID
 nextOfKinRelationshipId integer

近親與本人的關係
近親電話
 nextOfKinTelephone string

此人的近親電話號碼
撥號代碼
 dialingCode string

此人電話號碼的國際撥號代碼
工作擴展
 workExtension string

人員的工作擴充號碼
工作電話
 telephone string

此人的工作電話號碼
個人手機
 personalMobile string

此人的個人手機號碼
狀態標識碼
 statusId integer

此人的 StaffCircle 帳戶狀態
就業類型 ID
 employmentTypeId integer

該人的就業類型
合約類型 ID
 contractTypeId integer

該人的合約
合約到期
 contractExpiry date

人民勞動合同到期之日
就業狀況
 employmentStatusId integer

該人的就業狀況
第二就業狀況
 secondaryEmploymentStatusId integer

連結的二次就業狀況
就業須知
 employmentNotes string

有關該人的就業記錄
醫療筆記
 medicalNotes string

與該人相關的任何重要醫療記錄
是否啟用個人資料
 isPersonalDataEnabled boolean

是否啟用個人資料
是否已啟用聯絡人資料
 isContactDataEnabled boolean

是否啟用聯絡人資料
時區
 timeZone string

該人居住的時區

傳回

名稱 路徑 類型 Description
人員 ID
 id integer

人員的識別碼

建立新工作

作業識別碼：
CreateTask

建立新任務並將其指派給使用者

參數

名稱 機碼 必要 類型 Description
Title
 title True string

工作的標題
優先順序 ID
 priorityId integer

任務的優先順序。 如果未從工作群組衍生，則為必要
Description
 description string

給出任務的描述
工作表
 formId True integer

工作中使用的工作表
到期日
 dueDate date-time

任務到期完成日期
指派給 ID
 assignedToId integer

指派給誰的任務。 如果傳遞 Assigned To Email 則無法使用
管理員 ID
 managerId integer

誰在管理任務。 如果傳遞管理員電子郵件，則無法使用
工作群組識別碼
 taskGroupId True integer

指派任務的工作群組
指派給電子郵件
 assignedToEmail string

指派任務給誰的電子郵件。 如果傳遞 Assigned To Id，則無法使用
經理電子郵件
 managerEmail string

誰管理任務的電子郵件。 如果已傳遞管理員 ID，則無法指派
工作間隔 ID
 taskIntervalId integer

工作間隔的 ID。 如果工作週期性，則為必要
發送推送通知
 push boolean

傳送有關任務的推播通知
發送短信通知
 sms boolean

發送有關任務的短信通知
傳送電子郵件通知
 email boolean

傳送有關任務的電子郵件通知
傳送 Microsoft Teams 通知
 teams boolean

傳送有關工作的 Microsoft Teams 通知
發送應用程式內通知
 inApp boolean

在應用程序中發送有關任務的通知
允許按讚
 allowLikes boolean

允許使用者按讚工作上的留言
允許註解
 allowComments boolean

允許對任務進行註解
允許在註解中使用圖像
 allowImagesInComments boolean

所有圖片均需附加至評論
允許文件
 allowDocuments boolean

允許將文件附加至註解

傳回

名稱 路徑 類型 Description
ID
 id integer

工作的識別碼

建立新文章

作業識別碼：
CreateArticle

創建一篇新文章，可以通過多種溝通渠道分發給 StaffCircle 用戶

參數

名稱 機碼 必要 類型 Description
Title
 title True string

文章的標題。 長度上限 250 個字元
Priority
 priority True string

文章的優先級是什麼
文章類型
 articleType True string

要建立的條目類型
HTML 內容
 htmlContent True string

文章的主要 HTML 內容。
文章圖片網址
 mainImageUrl string

將用作摘要中文章主要影像的影像的 URL。
總結
 summary string

文章摘要。 如果未提供，預設為前 500 個字元 Html 內容。
標記
 tag True string

與文章相關聯的標籤。 最大字符 250
頻道 ID
 channelId integer

文章將發佈到哪個渠道。 如果留空，則將設定為預設摘要
發送推送通知
 push boolean

是否透過推播通知通知使用者有關文章的資訊
發送短信通知
 sms boolean

是否通過短信通知通知用戶文章
傳送電子郵件通知
 email boolean

是否要透過電子郵件通知通知使用者有關文章的資訊
發送應用程式內通知
 inApp boolean

是否通過應用內通知通知用戶有關該文章的信息
傳送 Teams 通知
 teams boolean

是否要透過 Microsoft Teams 通知通知使用者有關文章的資訊
允許按讚
 allowLikes boolean

用戶可以喜歡這篇文章嗎？ 預設值為 true
允許註解
 allowComments boolean

用戶可以對文章發表評論嗎？ 預設為 true。
允許在註解中使用圖像
 allowImagesInComments boolean

是否允許在註解中使用圖片
從日期固定
 pinFromDate date-time

該文章是否應該被固定。 如果是這樣，請給出日期。 如果提供 Pin 持續時間小時數，則為必要
釘選持續時間小時數
 pinDurationHours integer

在固定開始日期之後，文章應該保持固定狀態。 如果提供 Pin From Date，則為必要。
發佈排程日期時間
 scheduledDateTime string

這篇文章是否應該安排在未來發表。
立即發布
 publishImmediately boolean

這篇文章應該立即發表嗎
發佈使用者 ID
 publishAsUserId integer

如果不是進行 API 呼叫的使用者，則應代表哪個使用者進行此呼叫。

傳回

名稱 路徑 類型 Description
ID
 id integer

已建立之文章的識別碼

建立新目標

作業識別碼：
CreateObjective

建立新目標

參數

名稱 機碼 必要 類型 Description
能力
 categoryId True integer

連結的客觀能力
Title
 title True string

新目標的名稱。
Description
 description True string

新目標的描述。
開始日期
 startDate True date-time

從測量目標開始
結束日期
 endDate True date-time

目標的截止日期
值類型
 valueType True string

定義如何測量目標
標記
 tag string

文字標籤，用於搜尋和報告。
經理電子郵件
 managerEmail string

負責追蹤目標的經理的電子郵件。 自動預設為人員或部門管理員。 如果人員或部門沒有經理或目標是公司目標，則為必要項目。 如果未提供管理員 ID ，則使用該 ID
管理員 ID
 managerId integer

負責追蹤目標的經理。 自動預設為人員或部門管理員。 如果人員或部門沒有經理或目標是公司目標，則為必要項目。 如果未提供管理員電子郵件，則使用
人員電子郵件
 personEmail string

目標對象的電子郵件地址。 需要建立個人目標。 如果未提供部門或人員，則假設目標是公司目標
人員 ID
 personId integer

目標所針對人員的 ID。 需要建立個人目標。 如果未提供部門或人員，則假設目標是公司目標
部門名稱
 departmentName string

目標所在的部門名稱。 建立部門目標的必要條件。 如果未提供部門或人員，則假設目標是公司目標
部門識別碼
 departmentId integer

目標所在部門的 ID。 建立部門目標的必要條件。 如果未提供部門或人員，則假設目標是公司目標
公司目標標識碼
 companyObjectiveId integer

新建立目標所相關的公司目標的選擇性連結
部門目標識別碼
 departmentObjectiveId integer

新建立目標所關聯之部門目標的選用連結
起始值
 startValue double

定義如何測量目標
標的
 target double

成功完成目標要達到的目標值
允許新增進度
 allowAddProgress boolean

如果為true，則允許人員自行新增進度，否則只有指定的經理才能更新目標。 預設：false。
重複類型
 recurType string

如果提供，則目標是重複的。 定義週期的時間單位。
週期間隔
 recurInterval integer

目標將重複出現多少天/週/月/年。 如果目標重複出現，則為必要。
累計進度
 cumulativeProgress boolean

指定從 StaffCircle 前端新增進度時，是否將進度新增為增量值。
發送推送通知
 push boolean

發送推送通知。
發送短信通知
 sms boolean

發送短信通知
發送電子郵件通知
 email boolean

傳送電子郵件更新
傳送 Teams 通知
 teams boolean

如果啟用 Teams 整合，則透過 Microsoft Teams 傳送更新
發送應用程式內通知
 inApp boolean

傳送 InApp 通知
允許按讚
 allowLikes boolean

允許使用者按讚目標的留言
允許註解
 allowComments boolean

允許對目標發表評論
允許在註解中使用圖像
 allowImagesInComments boolean

所有圖片均需附加到評論中。
允許文件
 allowDocuments boolean

允許將文件附加至註解

傳回

名稱 路徑 類型 Description
目標標識碼
 id integer

目標識別碼

建立新警示

作業識別碼：
CreateAlert

創建一個新的警報，可以通過多種通信渠道分發給 StaffCircle 用戶

參數

名稱 機碼 必要 類型 Description
Title
 title True string

警示的標題
Priority
 priority True string

警示的優先順序是什麼
總結
 summary string

警報的主要內容
發送給所有人
 everyone boolean

是否應該將此警示傳送給公司中的所有使用者
傳送至部門標籤
 departmentTags string

以逗號分隔的部門標籤清單，顯示應接收警示的部門標籤。 如果 [傳送給所有人] 設定為 true ，則不要使用
傳送給人員標籤
 peopleTags string

以逗號分隔的人員標籤清單，列出應接收警示的人員標籤。 如果 [傳送給所有人] 設定為 true ，則不要使用
傳送至群組標籤
 groupTags string

以逗號分隔的群組標籤清單，以接收警示。 如果 [傳送給所有人] 設定為 true ，則不要使用
傳送至網站標籤
 siteTags string

以逗號分隔的網站標籤清單，顯示應接收警示的網站標籤。 如果 [傳送給所有人] 設定為 true ，則不要使用
發送推送通知
 push boolean

是否透過推播通知通知使用者
發送短信通知
 sms boolean

是否透過簡訊通知通知用戶
發送電子郵件通知
 email boolean

是否透過電子郵件傳送警示通知
發送應用程式內通知
 inApp boolean

是否透過應用程式內通知通知使用者
傳送 Microsoft Teams 通知
 teams boolean

是否要透過 Microsoft Teams 通知通知使用者

傳回

名稱 路徑 類型 Description
ID
 id integer

警示的識別碼

搜尋目標

作業識別碼：
GetObjectives

搜尋目標

參數

名稱 機碼 必要 類型 Description
搜尋標題
 SearchTitle string

鬆散字串比對以根據標題進行搜尋
人員電子郵件
 PersonEmail string

目標指派給之人員的電子郵件
標記
 Tag string

配置給目標的標籤
關閉
 Closed string

如果目標已關閉。 如果關閉，則為 true，否則為 false
目標類型
 ObjectiveType string

目標類型
寄件者
 From date-time

目標從此時開始活躍
發往
 To date-time

目標從此時開始活躍
活躍於
 ActiveAt date-time

此時點目標處於活動狀態

傳回

名稱 路徑 類型 Description
results
 results array of object

results
目標標識碼
 results.id integer

目標識別碼
Title
 results.title string

賦予目標的標題
Description
 results.description string

對目標的描述
標記
 results.tag string

與目標相關聯的標籤
目標類型
 results.objectiveType string

目標類型
關閉
 results.closed boolean

目標是否已關閉
關閉原因
 results.closedReason string

目標被關閉的原因
人員 ID
 results.person.id integer

目標所針對人員的識別碼
人名
 results.person.firstName string

目標所針對的人員的名字
個人姓氏
 results.person.secondName string

目標的人的姓氏是
管理員 ID
 results.manager.id integer

管理員的識別碼
經理名字
 results.manager.firstName string

經理的名字
經理族籍
 results.manager.secondName string

經理的姓氏
由人員識別碼建立
 results.createdBy.id integer

建立目標的人員識別碼
建立者名稱
 results.createdBy.firstName string

建立目標的人員的名字
建立者：人員姓氏
 results.createdBy.secondName string

建立目標的人員的姓氏
部門識別碼
 results.department.id integer

連結至目標的部門識別碼
部門名稱
 results.department.name string

連結至目標的部門名稱
部門目標識別碼
 results.departmentObjective.id integer

部門目標的標識符
部門目標標題
 results.departmentObjective.title string

部門目標標題
部門目標描述
 results.departmentObjective.description string

部門目標描述
公司目標標識碼
 results.companyObjective.id integer

公司目標標識符
公司目標名稱
 results.companyObjective.title string

公司目標標題
公司目標描述
 results.companyObjective.description string

公司目標描述
目前進度
 results.currentProgress double

目前目標的進展
開始日期
 results.startDate string

從測量目標開始
結束日期
 results.endDate string

目標的截止日期

更新目標分數

作業識別碼：
UpdateObjectiveScore

使用新分數和描述更新目標

參數

名稱 機碼 必要 類型 Description
目標標識碼
 objectiveId True string

進度分數要更新的目標
價值觀
 value True double

目前總進度
是增量
 isIncrement boolean

如果為 false，則傳遞的值是目標的目前值。 如果為true，則應將該值添加到現有總計中
Description
 description True string

簡要描述所取得的進展

傳回

名稱 路徑 類型 Description
ID
 id integer

目標進度記錄的識別碼

透過電子郵件取得人員

作業識別碼：
GetPerson

嘗試透過電子郵件尋找人員記錄

參數

名稱 機碼 必要 類型 Description
搜尋電子郵件
 SearchEmail True string

透過電子郵件搜尋

傳回

名稱 路徑 類型 Description
results
 results array of object

results
ID
 results.id integer

此人的身分證件
名字
 results.firstName string

此人的名字
Surname
 results.secondName string

此人的姓氏
被稱為
 results.knownAs string

這個人喜歡被稱為什麼名字
Email
 results.email string

此人的電子郵件地址
撥號代碼
 results.dialingCode string

人員電話號碼的撥號代碼
手機號碼
 results.mobile string

此人的手機號碼
主網站識別碼
 results.mainSite.id integer

人員相關聯之主要網站的識別碼
主要網站名稱
 results.mainSite.name string

主站點的名稱
描述
 results.mainSite.description string

描述
管理員
 results.mainSite.manager string

管理員
管理員 ID
 results.manager.id integer

馬槽 id
經理名字
 results.manager.firstName string

經理的名字
經理第二名
 results.manager.secondName string

經理的第二個名字
Active
 results.active boolean

此人目前是否活躍
部門識別碼
 results.department.id integer

與人員相關聯的部門識別碼
部門名稱
 results.department.name string

給部門的名稱
標記
 results.tag string

代表該人的標籤
角色 ID
 results.role.id integer

角色識別碼
角色名稱
 results.role.name string

角色名稱
個人資料圖片
 results.avatarURL string

人員設定檔圖片的 URL
狀態標識碼
 results.status.id integer

記錄狀態 ID
狀態名稱
 results.status.name string

記錄狀態名稱
人員狀態 ID
 results.personStatus.id integer

人員狀態識別碼
人員狀態名稱
 results.personStatus.name string

人員狀態名稱
開始日期
 results.startDate string

此人第一次開始在組織工作的時間

觸發程序

新增人員時

新增人員時觸發
新增任務時

新增任務時觸發
新增目標時

新增目標時觸發
新增缺勤時

新增缺勤時觸發
新增評論時

新增檢閱時觸發
更新目標時

更新目標時觸發
當有新文章發表時

發佈新文章時觸發

新增人員時

作業識別碼：
NewPerson

新增人員時觸發

參數

名稱 機碼 必要 類型 Description
名稱
 name True string

Webhook 的名稱

傳回

名稱 路徑 類型 Description
記錄網址
 subjectFrontEndUrl string

StaffCircle 中記錄的 URL
人員 ID
 data.id integer

代表人員的識別碼
名字
 data.givenName string

此人的名字
中間名
 data.middleName string

此人的中間名
姓
 data.familyName string

此人的姓氏
被稱為
 data.knownAs string

這個人喜歡被稱為什麼名字
出生日期
 data.dateOfBirth date

此人的出生日期
個人 Email
 data.contactDetails.personalEmail string

此人的個人電子郵件地址
工作電子郵件
 data.contactDetails.workEmail string

人員的工作電子郵件地址
行動工作
 data.contactDetails.workMobile string

此人的工作手機號碼
個人手機
 data.contactDetails.personalMobile string

此人的個人手機號碼
家居電話
 data.contactDetails.homeTelephone string

此人的住家電話號碼
工作電話
 data.contactDetails.workTelephone string

此人的工作電話號碼
工作電話
 data.contactDetails.workExtension string

人員的工作擴充號碼
地址行 1
 data.address.addressLine1 string

此人住家地址的第一行
地址行 2
 data.address.addressLine2 string

此人住家地址的第一行
鎮
 data.address.town string

該人的居住城市
郵遞區號
 data.address.postCode string

此人的郵遞區號
緊急聯絡人姓名
 data.emergencyContact.emergencyContactName string

此人的緊急聯絡人名稱
緊急聯絡電話
 data.emergencyContact.emergencyContactTelephone string

該人的緊急聯絡人的電話號碼
緊急聯絡人關係 ID
 data.emergencyContact.emergencyRelationshipId integer

緊急聯絡人與人之間的關係
緊急聯絡人同意書
 data.emergencyContact.emergencyContactConsent boolean

緊急聯絡人是否同意儲存其詳細資料
緊急聯絡地址
 data.emergencyContact.emergencyAddress string

該人員的緊急聯絡地址
醫療筆記
 data.emergencyContact.emergencyMedicalNotes string

與該人相關的任何重要醫療記錄
近親姓名
 data.nextOfKin.Name string

該人的近親
近親電話
 data.nextOfKin.Telephone string

此人的近親電話號碼
近親關係 ID
 data.nextOfKin.RelationshipId string

近親與本人的關係
就業須知
 data.employeeDetails.employmentNotes string

有關該人的就業記錄
標記
 data.employeeDetails.tag string

可用於在整個 StaffCircle 平台中引用人員的標籤
開始日期
 data.employeeDetails.startDate string

該人的受僱時間
站台識別碼
 data.employeeDetails.siteId integer

人員所屬的網站識別碼
群組識別碼
 data.employeeDetails.groupId integer

該人所屬的群組
部門識別碼
 data.employeeDetails.departmentId integer

該人所屬的部門
管理員 ID
 data.employeeDetails.manager.PersonId integer

牧師經理的 ID
經理的名字
 data.employeeDetails.manager.FirstName string

人員經理的名字
經理姓氏
 data.employeeDetails.manager.FamilyName string

此人經理的姓氏
經理電子郵件
 data.employeeDetails.manager.Email string

此人經理的電子郵件地址
帳戶狀態
 data.accountStatus integer

此人的 StaffCircle 帳戶狀態

新增任務時

作業識別碼：
NewTask

新增任務時觸發

參數

名稱 機碼 必要 類型 Description
名稱
 name True string

Webhook 的名稱

傳回

名稱 路徑 類型 Description
記錄網址
 subjectFrontEndUrl string

StaffCircle 中記錄的 URL
ID
 data.id integer

任務的識別碼
Title
 data.title string

工作的標題
Description
 data.description string

工作的描述
Priority
 data.priority string

任務的優先順序
工作群組識別碼
 data.groupId integer

工作群組的識別碼
工作群組標題
 data.groupTitle string

工作群組的標題
是臨時的
 data.isAdhoc boolean

這是否是臨時任務
由人員 ID 建立
 data.createdByPerson.PersonId integer

建立任務之人員的識別碼
依名字建立
 data.createdByPerson.FirstName string

建立任務的人員的名字
依姓氏建立
 data.createdByPerson.FamilyName string

建立任務之人員的姓氏
透過電子郵件建立
 data.createdByPerson.Email string

建立任務之人的電子郵件
人員 ID
 data.person.PersonId integer

任務所針對人員的識別碼
人名
 data.person.FirstName string

任務所針對人員的名字
個人姓氏
 data.person.FamilyName string

任務所針對人員的姓氏
人員電子郵件
 data.person.Email string

任務所針對人員的電子郵件
管理員 ID
 data.manager.PersonId integer

工作管理員的識別碼
經理名字
 data.manager.FirstName string

任務經理的名字
經理族籍
 data.manager.FamilyName string

任務管理員的姓氏
經理電子郵件
 data.manager.Email string

任務經理的電子郵件
到期日
 data.dueDate date

任務到期時
創建日期
 data.createdOn date-time

工作建立時間
表單 ID
 data.form.id integer

用來填寫任務的表單識別碼
表單標題
 data.form.title string

用來填寫任務的表單標題
推播通知
 data.notificationSettings.push boolean

是否會傳送任務的推播通知
簡訊通知
 data.notificationSettings.sms boolean

是否會傳送任務的簡訊通知
電子郵件通知
 data.notificationSettings.email boolean

是否會傳送任務的電子郵件通知
Microsoft Teams 通知
 data.notificationSettings.microsoftTeams boolean

是否會在 Microsoft Teams 中傳送工作的通知
應用內通知
 data.notificationSettings.inApp boolean

是否會傳送工作的應用程式內通知
允許按讚
 data.contentSettings.allowLikes boolean

任務是否允許按讚
允許註解
 data.contentSettings.allowComments boolean

工作是否允許註解
允許在註解中使用圖像
 data.contentSettings.allowImagesInComments boolean

工作是否允許在註解中使用影像
允許文件
 data.contentSettings.allowDocuments boolean

工作是否允許文件

新增目標時

作業識別碼：
NewObjective

新增目標時觸發

參數

名稱 機碼 必要 類型 Description
名稱
 name True string

Webhook 的名稱

傳回

名稱 路徑 類型 Description
記錄網址
 subjectFrontEndUrl string

StaffCircle 中記錄的 URL
目標標識碼
 data.id integer

目標的識別碼
目標範本
 data.templateId integer

從目標範本建立新目標
管理員 ID
 data.manager.PersonId integer

人員的經理識別碼
經理名字
 data.manager.FirstName string

人員的經理名字
經理族籍
 data.manager.FamilyName string

此人經理的姓氏
經理電子郵件
 data.manager.Email string

此人經理的電子郵件地址
人員識別碼
 data.person.PersonId integer

連結至目標的人員識別碼
人名
 data.person.FirstName string

與目標連結的人員名字
個人姓氏
 data.person.FamilyName string

與目標連結的人員姓氏
人員電子郵件
 data.person.Email string

連結至目標的人員電子郵件地址
Title
 data.title string

新目標的名稱
Description
 data.description string

新目標的描述
值類型
 data.valueType string

定義如何測量目標
標記
 data.tag string

文字標籤，用於搜尋和報告
類別
 data.category string

目標類別識別碼
開始日期
 data.startDate date-time

從測量目標開始
結束日期
 data.endDate string

目標的截止日期
最後進度日期
 data.lastProgressDate date-time

目標取得進展的日期
關閉
 data.closed boolean

關閉
允許新增進度
 data.allowAddProgress boolean

如果為true，則允許人員自行新增進度，否則只有指定的經理才能更新目標
推播通知
 data.notificationSettings.push boolean

發送推送通知。
簡訊通知
 data.notificationSettings.sms boolean

發送短信通知
電子郵件通知
 data.notificationSettings.email boolean

傳送電子郵件更新
Teams 通知
 data.notificationSettings.microsoftTeams boolean

如果啟用 Teams 整合，則透過 Microsoft Teams 傳送更新
應用內通知
 data.notificationSettings.inApp boolean

傳送 InApp 通知
允許按讚
 data.contentSettings.allowLikes boolean

允許使用者按讚目標的留言
允許註解
 data.contentSettings.allowComments boolean

允許對目標發表評論
允許在註解中使用圖像
 data.contentSettings.allowImagesInComments boolean

所有圖片均需附加到評論中。
允許文件
 data.contentSettings.allowDocuments boolean

允許將文件附加至註解
創建於
 data.createdAt date-time

當目標建立時
由人員識別碼建立
 data.createdByPerson.PersonId integer

建立目標的人員識別碼
建立者名稱
 data.createdByPerson.FirstName string

建立目標的人員的名字
建立者：人員姓氏
 data.createdByPerson.FamilyName string

建立目標的人員的姓氏
由個人電子郵件建立
 data.createdByPerson.Email string

建立目標之人的電子郵件地址
目前進度
 data.currentProgress double

目前目標的進展
起始值
 data.startValue double

定義如何測量目標
標的
 data.targetValue double

成功完成目標要達到的目標值

新增缺勤時

作業識別碼：
NewAbsence

新增缺勤時觸發

參數

名稱 機碼 必要 類型 Description
名稱
 name True string

Webhook 的名稱

傳回

名稱 路徑 類型 Description
記錄網址
 subjectFrontEndUrl string

StaffCircle 中記錄的 URL
ID
 data.id integer

缺席的識別碼
人員 ID
 data.requestedForPerson.PersonId integer

缺勤要求所針對人員的識別碼
人名
 data.requestedForPerson.FirstName string

缺勤請求所針對的人員的名字
個人姓氏
 data.requestedForPerson.FamilyName string

缺勤申請所針對的人員的姓氏
人員電子郵件
 data.requestedForPerson.Email string

缺勤申請所針對人員的電子郵件地址
單位類型
 data.unitType string

缺勤申請單位類型 （小時、天）
小時數
 data.numberOfHours double

已請求關閉的小時數
部分日
 data.partialDay string

是否已要求休假（上午、下午）
開始日期
 data.start date-time

缺席開始時
結束日期
 data.end date-time

當缺席結束時
類型 ID
 data.typeId integer

所要求缺勤類型的識別碼
類型
 data.type string

所要求的缺勤類型
子類型 ID
 data.subTypeId integer

所要求缺勤子類型的識別碼
原則識別碼
 data.policyId integer

員工所適用缺勤原則的識別碼
原因
 data.reason string

缺勤請求的原因
創建日期
 data.createdAt date-time

何時提出缺勤請求
由 ID 建立
 data.createdByPerson.PersonId integer

建立缺勤要求的人員識別碼
依名字建立
 data.createdByPerson.FirstName string

建立缺勤申請的人員的名字
依姓氏建立
 data.createdByPerson.FamilyName string

建立缺勤申請的人員的姓氏
透過電子郵件建立
 data.createdByPerson.Email string

建立缺勤申請之人的電子郵件地址
核准狀態
 data.approvalDetails.status string

核准狀態 （擱置中、已核准、已拒絕）
核准日期
 data.approvalDetails.approvedAt date-time

缺勤何時獲得批准
核准回應
 data.approvalDetails.response string

核准者給出的回應
由 ID 批准
 data.approvalDetails.approvedByPerson.PersonId integer

核准缺勤人員的識別碼
依名字核准
 data.approvalDetails.approvedByPerson.FirstName string

核准缺勤人員的名字
按姓氏批准
 data.approvalDetails.approvedByPerson.FamilyName string

批准缺勤的人的姓氏
通過電子郵件批准
 data.approvalDetails.approvedByPerson.Email string

核准缺勤之人的電子郵件地址
管理員 ID
 data.manager.PersonId integer

缺勤要求中涉及的經理識別碼
經理名字
 data.manager.FirstName string

缺勤要求中涉及的經理的名字
經理族籍
 data.manager.FamilyName string

缺勤請求中涉及的經理的姓氏
經理電子郵件
 data.manager.Email string

參與缺勤要求的經理的電子郵件地址

新增評論時

作業識別碼：
NewReview

新增檢閱時觸發

參數

名稱 機碼 必要 類型 Description
名稱
 name True string

Webhook 的名稱

傳回

名稱 路徑 類型 Description
記錄網址
 subjectFrontEndUrl string

StaffCircle 中記錄的 URL
ID
 data.id integer

檢閱識別碼
上一頁評論 ID
 data.previousReviewId integer

此被檢閱者先前檢閱的識別碼
管理員 ID
 data.manager.PersonId integer

與檢閱相關聯的管理員識別碼
經理名字
 data.manager.FirstName string

與檢閱相關聯的經理的名字
經理族籍
 data.manager.FamilyName string

與檢閱相關聯的經理姓氏
經理電子郵件
 data.manager.Email string

與檢閱相關聯的管理員電子郵件地址
internalReviewerPersonIds
 data.internalReviewerPersonIds array of integer

internalReviewerPersonIds
被檢閱者 ID
 data.person.PersonId integer

被檢閱者的識別碼
被審查者名字
 data.person.FirstName string

被審查者的名字
被審查者姓氏
 data.person.FamilyName string

被檢閱者的姓氏
被審稿人電子郵件
 data.person.Email string

被檢閱者的電子郵件地址
Title
 data.title string

評論的標題
Description
 data.description string

對評論的描述
審查類型
 data.reviewType string

審查類型
到期日
 data.dueOn date-time

審查到期時
attachedDocumentIds
 data.attachedDocumentIds array of integer

attachedDocumentIds
連結目標
 data.linkedObjectives array of integer

連結目標
評估範本 ID
 data.appraisalSummary.personAppraisalTemplateId integer

用來建立評估的評估範本
當前分數
 data.scores.currentScore double

評論當前得分
創建日期
 data.createdAt date-time

建立檢閱的時間
由 ID 建立
 data.createdByPerson.PersonId integer

建立評論之人的識別碼
依名字建立
 data.createdByPerson.FirstName string

建立評論的人員的名字
依姓氏建立
 data.createdByPerson.FamilyName string

建立評論之人的姓氏
透過電子郵件建立
 data.createdByPerson.Email string

建立評論的人員的電子郵件地址
允許按讚
 data.contentSettings.allowLikes boolean

是否允許點贊
允許註解
 data.contentSettings.allowComments boolean

是否允許對審查發表評論
允許在註解中使用圖像
 data.contentSettings.allowImagesInComments boolean

是否允許在註解中使用圖片
允許文件
 data.contentSettings.allowDocuments boolean

是否可以將文件附加到審查中
推播通知
 data.notificationSettings.push boolean

是否發送推送通知
簡訊通知
 data.notificationSettings.sms boolean

是否發送簡訊通知
電子郵件通知
 data.notificationSettings.email boolean

是否傳送電子郵件通知
Microsoft Teams 通知
 data.notificationSettings.microsoftTeams boolean

是否要傳送 Microsoft Teams 通知
應用內通知
 data.notificationSettings.inApp boolean

是否傳送應用程式內通知

更新目標時

作業識別碼：
UpdateObjective

更新目標時觸發

參數

名稱 機碼 必要 類型 Description
名稱
 name True string

Webhook 的名稱

傳回

名稱 路徑 類型 Description
記錄網址
 subjectFrontEndUrl string

StaffCircle 中記錄的 URL
ID
 data.id integer

目標進度記錄的識別碼
目標標識碼
 data.objectiveId integer

此進度記錄與之相關聯的目標
價值觀
 data.value double

物件的進度總計值
Description
 data.description string

新增至目標進度記錄的說明
創建日期
 data.createdAt date-time

建立進度記錄的時間
由人員 ID 建立
 data.createdByPerson.PersonId integer

建立進度目標記錄之人員的識別碼
依名字建立
 data.createdByPerson.FirstName string

建立目標進度記錄的人員的名字
依姓氏建立
 data.createdByPerson.FamilyName string

建立目標進度記錄之人的姓氏
透過電子郵件建立
 data.createdByPerson.Email string

建立目標進度記錄之人員的電子郵件地址
發送通知
 data.sendNotifications boolean

說明通知是否傳送

當有新文章發表時

作業識別碼：
PublishedArticle

發佈新文章時觸發

參數

名稱 機碼 必要 類型 Description
名稱
 name string

名稱

傳回

名稱 路徑 類型 Description
文章網址
 subjectFrontEndUrl string

文章的網址
ID
 data.Id integer

文章的識別碼
Title
 data.Title string

文章的標題
總結
 data.Summary string

文章摘要
標記
 data.Tag string

與文章相關聯的標籤
優先順序名稱
 data.PriorityName string

文章的優先級
創建日期
 data.CreatedAt date-time

條目首次創建的日期
每個人
 data.AudienceDto.Everyone boolean

文章是否發布給所有人
人員
 data.AudienceDto.Persons array of object
人員標籤
 data.AudienceDto.Persons.Tag string

目標人物標籤
Id
 data.AudienceDto.Persons.Id integer

標籤 ID
Sites
 data.AudienceDto.Sites array of object
網站標籤
 data.AudienceDto.Sites.Tag string

目標網站標籤
Id
 data.AudienceDto.Sites.Id integer

標籤 ID
Departments
 data.AudienceDto.Departments array of object
部門標籤
 data.AudienceDto.Departments.Tag string

目標部門標籤
Id
 data.AudienceDto.Departments.Id integer

標籤 ID
由 ID 建立
 data.CreatedByPerson.PersonId integer

建立文章的人員的識別碼
依名字建立
 data.CreatedByPerson.FirstName string

創建文章的人的名字
依姓氏建立
 data.CreatedByPerson.FamilyName string

建立文章的人員的姓氏
透過電子郵件建立
 data.CreatedByPerson.Email string

文章建立者的電子郵件地址
修改時間
 data.ModifiedAt date-time

條目最後修改時間
依 ID 修改
 data.ModifiedByPerson.PersonId integer

上次修改文章的人員的識別碼
依名字修改
 data.ModifiedByPerson.FirstName string

上次修改條目的人的名字
依族名修改
 data.ModifiedByPerson.FamilyName string

上次修改條目的人的姓氏
透過電子郵件修改
 data.ModifiedByPerson.Email string

上次修改文章的人員的電子郵件地址
發佈日期
 data.PublishedDate date-time

文章發表時間
文章內容
 data.ArticleContent string

文章的HTML內容
文章內容正文
 data.ArticleContentText string

純文字文章內容
主影像 ID
 data.MainImageId integer

將用作摘要中文章主要圖像的圖像的 ID。