Webhook (Message)

Functions

The Webhook (Message) function can help synchronize to-do reminder, message notifications, and CC notifications to your server, thus facilitating business integration for enterprises.

Setting Procedure

Where to Set

Click you avatar, go to Management > Webhook (Message), and enable the function.

Configuring a Server

Click Configuration, enter a server address, and click Generate Secret to automatically generate a secret. Then you can click Test Connection to test whether the connection is successful before clicking Save.

Description of Push Data Structure

Field

Type

Description

op

string

Push events

data

json

Push content

send_time

string

Push time

Here is the sample:

{
    op: "flow_message", //Push events
    data: {
        to: [{
            username: "Jodoo",
            name: "Martin"    
        }],
        entry_name: "Leave approval",
        notify_text: "Martin will take a day off this Friday.",
        url: "https://abc.com/xyz"
    }, //Push content
    send_time: "2017-10-20T22:41:51.430Z" //Push time
}

Push Events

At Specific Time

1. How to configure

Go to Extension > Notification > New Notification, select At Specific Time, and tick Push to My Server.

2. Push content

Field

Type

Description

op

string

"form_schedule_message", fixed value

data

json

Push content

data.to

json[]

Reminder recipient list

Reminder Recipient List

string

Name of the pushed source form

data.notify_text

string

The content is Please note this is your reminder to check by default. You can customize the content.

data.url

string

Form internal link. You have to obtain the permission to access the link.

send_time

string

Push time

3. Cases

{
	op: "form_schedule_message",
	data: {
		to: [
			{
				username: "Martin",
				name: "Peach"
			}, {
				username: "Melon",
				name: "Peter"
			}
		],
		entry_name: "Leave approval",
		notify_text: "Martin sends a leave application for approval",
		url: "https://jodoo.com/app/1/entry/2"
	},
	send_time: "2017-10-20T22:41:51.430Z"
}

When a Record is Created

1. How to Configure

Go to Extension > Notification > New Notification, select When a record is created, and tick Push to My Server.

2. Push Content

Field

Type

Description

op

string

“data_create_message”,fixed value

data

json

Push content

data.to

json[]

Reminder recipient list

Reminder Recipient List

string

Name of the pushed source form

data.notify_text

string

The content is Please note new data were submitted by default. You can customize the content.

data.content

string

Data content, the form field title with value, and the field value. For example: single line: 123\n multi line: 1233\n number: 123\n member: codingmagic1\n department: development\n date & time: 2019-06-13

data.url

string

A static message link that is the recipient's personal message. You can access the link after logging in.

send_time

string

Push time

3. Cases

{
	op: "data_create_message",
	data: {
		to: [
			{
				username: "Martin",
				name: "Peach"
			}, {
				username: "Melon",
				name: "Peter"
			}
		],
		entry_name: "Leave approval",
		notify_text: "Martin sends a leave application for approval",
		content: "Applicant: martin\n reason: sickness",
		url: "https://jodoo.com/message/1/data"
	},
	send_time: "2017-10-20T22:41:51.430Z"
}

When a Record is Updated

1. How to configure

Go to Extension > Notification > New Notification, select When a record is updated, and tick Push to My Server.

2. Push content

Field

Type

Description

op

string

“data_update_message”, fixed value

data

json

Push content

data.to

json[]

Reminder recipient list

data.entry_name

string

Name of the pushed source form

data.notify_text

string

The content is Please note data has been updated by default. You can customize the content.

data.content

string

The data content of Created User and Record Title fields, and updated fields. For example: updated user: test_li\n record title: 1231\n single line: 123→1231\n member: codingmagic1→codingjun

data.url

string

Form internal link. You have to obtain the permission to access the link.

send_time

string

Push time

3. Cases

{
	op: "data_update_message",
	data: {
		to: [
			{
				username: "Martin",
				name: "Peach"
			}
		],
		entry_name: "Leave approval",
		notify_text: "Martin has updated the leave date",
		content: "Updated user: martin\n record title: sick leave application: 2018-5-1→2018-5-2",
		url: "https://jiandaoyun.com/dashboard/app/1/form/2/data/3/qr_link"
	},
	send_time: "2017-10-20T22:41:51.430Z"
}

Choose a Date&Time field

1. How to configure

Go to Extension > Notification > New Notification, select Choose a Date&Time field, and tick Push to My Server.

2. Push Content

Field

Type

Description

op

string

"form_widget_message", fixed value

data

json

Push content

data.to

json[]

Reminder recipient list

Reminder Recipient List

string

Name of the pushed source form

data.notify_text

string

The content is Please be alerted that some jobs are overdue by default. You can customize the content.

data.content

string

The data content of Record Title field.

data.url

string

Data internal link. The system will send the link when ten entries are exceeded in a single form. You have to obtain the permission to access the link.

send_time

string

Push time

3. Cases

{
	op: "form_widget_message",
	data: {
		to: [
			{
				username: "Martin",
				name: "Peach"
			}
		],
		entry_name: "Birthday reminder",
		notify_text: "Martin's birthday is coming",
		content: "Martin's birthday is coming",
		url: "https://jodoo.com/dashboard/app/1/form/2/data/3/qr_link"
	},
	send_time: "2017-10-20T22:41:51.430Z"
}

Workflow Reminder

When it comes to workflow initiating, CC, transferring, returning, timeout, activating, approver changing in a workflow, the system will send a reminder to the current approver.

1. How to configure

Go to Workflow > Workflow Reminder, and click Push to My Server.

2. Push content

Field

Type

Description

op

string

"flow_message", fixed value

data

json

Push content

data.flow_action

string

Workflow action

data.to

json[]

Reminder recipient list

Reminder Recipient List

string

Name of the pushed source form

data.notify_text

string

The content is Please note data has been updated by default. You can customize the content.

data.content

string

The data content of Brief field.

data.url

string

Data internal link. You have to obtain the permission to access the link.

send_time

string

Push time

Different flow actions correspond to different push contents.

Workflow Action

Description

Content

Details

flow_forward

Submit

You have a new task

Brief. For example: "Single Line: 123\n Multi Line: 123\n Number: 123"

flow_auto_forward

Automatic submission by the system

You have a new task

flow_back

Return

The submitted workflow has been returned.

flow_auto_back

Automatic return by the system

The submitted workflow has been returned.

flow_cc

CC

You are CCed on a new solved workflow result

flow_timeout

Workflow timeout

The prompt text is There exist unfinished tasks. Please handle them in time by default. You can customize the text in the timeout reminder settings.

flow_member_transfer

Transfer

A task is transferred to you by 「~$transferrer

flow_admin_transfer

The admin has changed approver for a workflow record.

A task is transferred to you by the super admin

flow_activate

Workflow activated

A task is transferred to you by the super admin

flow_sign_before

Add pre-approver

A task is transferred to you by 「~$added approver」

flow_sign_after

Add post-approver

A task is transferred to you by 「~$added approver」

flow_sign_parallel

Add an approver

A task is transferred to you by 「~$added approver」

flow_sign_before_complete

Pre-approver added

Pre-approver added. A task is transferred to you.

flow_batch_transfer

The admin has changed approvers for multiple workflow records

A task is transferred to you by the super admin

/

flow_batch_forward

Multiple workflows submitted

Transferred to you [~$count] task(s).

/

flow_batch_cc

Multiple workflows CC'ed

CC'ed to you [~$count]

workflow result(s)

/

flow_urge

Workflow Expediting

A workflow needs to be handled urgently

/

Dashboard Reminder

1. How to configure

Select a dashboard and go to Design > Reminder. Then tick Push to My Server after finishing all settings.

2. Push Content

Field

Type

Description

op

string

"dash_schedule_message", fixed value

data

json

Push content

data.to

json[]

Reminder recipient list

data.entry_name

string

Name of the pushed source form

data.notify_text

string

The content is Please note this is your reminder to check by default. You can customize the content.

data.url

string

Data internal link. You have to obtain the permission to access the link.

send_time

string

Push time

3. Cases

{
	op: "dash_schedule_message",
	data: {
		to: [
			{
				username: "Martin",
				name: "Peach"
			}
		],
		entry_name: "Birthday reminder",
		notify_text: "Martin's birthday is coming",
		url: "https://jodoo.com/app/1/entry/2"
	},
	send_time: "2017-10-20T22:41:51.430Z"
}

Data Alert in Dashboard

1. How to configure

On the stats editing page, go to Settings > Data Alert to add an alert. Then tick Push to My Server before finishing all the settings.

2. Push content

Field

Type

Description

op

string

"dash_alert_message", fixed value

data

json

Push content

data.to

json[]

Reminder recipient list

Reminder Recipient List

string

Name of the pushed source form

data.notify_text

string

Use the name of the alert as the reminder text

data.content

string

Data content. Alert source: {app name}>{dashboard name}>{component name}

data.url

string

Data internal link. You have to obtain the permission to access the link.

send_time

string

Push time

3. Cases

{
	op: "dash_alert_message",
	data: {
		to: [
			{
				username: "Martin",
				name: "Peach"
			}
		],
		entry_name: "Inventory statistics",
		notify_text: "Inventory alert",
		content: "Alert source: inventory app>america>inventorybalance",
		url: "https://jodoo.com/app/1/entry/2"
	},
	send_time: "2017-10-20T22:41:51.430Z"
}

Was this information helpful?
Yes
NoNo
Need more help? Contact support