資料推送

功能簡介

當表單資料的發生變更時,資料推播可將變更後的資料推播至您的伺服器。

操作步驟

設定入口

進入「擴展功能 > 資料推播」,即可新建資料推播:

配置方法

資料推播的配置內容如下:

1. 目標伺服器:可以選擇客製化伺服器推播。

2. 伺服器地址:資料會以 HTTP POST 請求的形式,推播至目標伺服器地址。

3. 伺服器連接測試:填寫好伺服器地址後,可以對伺服器進行連接測試。當我們在進行伺服器連接測試的時候,如果推播失敗,也可以看到推播失敗的詳情。

4. Secret:點擊生成 Secret 將自動生成 Secret 到文字框內,無需手動填寫。

5. 推播事件:當發生所選擇的事件時,資料纔會被推播,支援的推播事件如下:

推播事件

事件描述

備註

有新資料送出時推播

送出表單資料時觸發

必選

有資料被修改時推播

修改表單資料的內容時觸發,包括流程資料流轉、修改表單資料等

可選,批次修改時不支援

有資料被刪除時推播

刪除表單資料時觸發

可選,批次刪除時不支援

有資料被恢復時推播

恢復表單資料時觸發

可選,批次恢復時不支援

表單結構有變化時推播

修改表單結構配置時觸發

可選

設定欄位別名

Webhook 資料推播中的欄位名,和透過 API 查詢 API 請求返回給使用者的欄位名均為「widget+欄位 ID」的樣式,沒有辨識性。透過欄位別名的設定,可以使欄位名稱在資料推播中更具有辨識度。

資料推播、發送 API 請求和返回回應資料時,可使用欄位別名來替換欄位 ID。

附註

欄位別名僅允許使用「小寫字母」、「數字」和「下劃線」組合,且必須以「小寫字母」開頭。

欄位對照表及 JSON 樣例

欄位對照表及 JSON 樣例包含了當前表單中的全部欄位,以及每個欄位對應的 ID/別名、欄位類型、說明。寫程式碼時可參照「欄位對照表及 JSON 樣例」進行書寫。

推播內容

推播事件列表

推播事件

描述

備註

有新資料送出時推播

透過表單送出一筆資料時觸發

必選;不支援批次匯入資料

有資料被修改時推播

修改一筆資料的內容時觸發,包括流程資料流轉、普通表單修改資料、管理員修改資料等

可選;不支援批次修改

有資料被刪除時推播

刪除一筆資料時觸發

可選;不支援批次刪除

有資料被恢復時推播

恢復一筆資料時觸發

可選;不支援批次恢復

資料結構定義如下:

參數

說明

op

推播事件;包括 data_create (資料送出)、data_update (資料修改)、data_remove (資料刪除)、data_recover (資料恢復)

data

具體資料內容

1. 新資料送出/資料修改/資料恢復

可根據資料推播配置界面的「欄位對照表及 JSON 樣例」參考當前表單推播資料的格式及內容。

a. Jodoo表單欄位類型與資料類型對照表如下:

欄位類型

資料類型

備註

單行文字

string

/

多行文字

string

/

流水號

string

表單新增流水號控件時,歷史資料無流水號

數字

number

/

日期時間

string

/

單選

string

/

複選

array

/

下拉單選

string

/

下拉複選框

array

/

分割線

/

不推播

圖片

array

推播資料中包含的 url 為圖片連結,6 天內有效

附件

array

推播資料中包含的 url 為附件連結,6 天內有效

手寫簽名

json

推播資料中包含的 url 為手寫簽名的圖片連結,6 天內有效

子表單

array

/

查詢

/

不推播

選擇資料

json

/

成員單選

json

status 對應的邏輯:

-1 離職

0 未加入

1 已加入

成員多選

array

status 對應的邏輯:

-1 離職

0 未加入

1 已加入

部門單選

json

/

部門多選

array

/

流程狀態(僅流程表單)

number

2 表示流程手動結束

1 表示流程已完成

0 表示流程進行中

表單名稱

string

/

資料 ID

string

/

送出人

json

status 對應的邏輯:

-1 離職

0 未加入

1 已加入

修改人

json

status 對應的邏輯:

-1 離職

0 未加入

1 已加入

刪除人

json

status 對應的邏輯:

-1 離職

0 未加入

1 已加入

送出時間

string

使用 utc 時間戳,請根據所在時區處理

修改時間

string

使用 utc 時間戳,請根據所在時區處理

刪除時間

string

使用 utc 時間戳,請根據所在時區處理

使用者暱稱

string

/

使用者性別

string

/

2. 資料刪除

欄位

欄位類型

說明

formName

String

表單名稱

_id

String

刪除資料的 ID

deleter

json

刪除操作執行人

deleteTime

String

刪除時間

推播失敗

當資料推播失敗時,管理員會收到通知。管理員可調整配置後,在「資料推播」處點擊「重新推播」,重新推播失敗的資料。

附註

1. 資料推播失敗時,管理員可以選擇重新推播失敗快取裏的資料,也可以放棄快取。失敗資料僅可保留 7 天,超時後無法再進行重新推播。

2. 當失敗記錄達到 100 筆,會關閉資料推播功能,同時管理員會收到一筆資料推播關閉的訊息通知,需要在資料推播設定中重新啟動資料推播,資料推播纔會繼續推播。

推播日誌

在資料推播頁面,點擊推播事件後的「推播日誌」,即可查看推播失敗/成功的記錄,還可以在記錄中查看推播詳情:

  • 推播日誌裏僅保留近六個月的推播記錄;
  • 支援根據推播失敗、推播成功、全部日誌去篩選查詢推播記錄;
  • 推播日誌裏記錄了每筆推播記錄的時間、地址、結果,當推播失敗了還可以查看推播詳情:

這項資訊有幫助嗎?
需要更多協助嗎?聯繋技術支援。