Webhook (Data) - Jodoo - Open Platform

Functions

When you modify data in a form, the system can push the updated data to your server through Webhook.

Setting Procedure

Where to Set

Go to Extension > Webhook > New to create a webhook.

How to Configure

You can set the followings in Webhook:

1. Target Server: You can select Custom Server to push data.

2. Server Address: The data will be pushed to the target server address via HTTP POST requests.

3. Test Connection: Click Test Connection to conduct the connection test. You can view push failure details if the push failed.

4. Secret: Click Generate Secret to automatically enter a secret into the text box. You do not have to manually enter the secret.

5. Push Events: Only when the event you selected occurs can the data be pushed. The following push events are supported.

Push Events	Event Description	Notes
When data is created	Pushed when you submit data in a form.	Required
When data is updated	Pushed when you update data in a form, including data flowing in a workflow, form data editing, and so on.	Optional. Not pushed when you batch update data.
When data is deleted	Pushed when you delete data in a form.	Optional. Not pushed when you batch delete data.
When data is recovered	Pushed when you recover data in a form.	Optional. Not pushed when you batch recover data.
When the form structure changes	Pushed when you change the structure of a form.	Optional

Setting Field Alias

The field names in Webhook and the field names returned to the user through the API query interface are both in the format of "widget+field ID". Therefore, they are not easily recognizable or distinguishable. By setting field aliases, field names can be made more identifiable in data pushes.

When the system pushes data, sends API requests, and returns response data, field aliases can be used to replace field IDs.

Note: Only combinations of lowercase letter, number, and underline are allowed in Field Aliases, and they have to begin with lowercase letter.

Field Comparison Table and JSON Example

Field Comparison Table and JSON Example include all fields in the form and Field ID/Field Alisa, Field Type, and Description for each field. You can refer to Field Comparison Table and JSON Examples when writing codes.

What to Push

Push Events List

Push Events	Description	Notes
When data is created	Pushed when you submit data in a form.	Required. Not pushed when you batch import data.
When data is updated	Pushed when you update data in a form, including data flowing in a workflow, form data editing, data updating by a admin, and so on.	Optional. Not pushed when you batch update data.
When data is deleted	Pushed when you delete data in a form.	Optional. Not pushed when you batch delete data.
When data is recovered	Pushed when you recover data in a form.	Optional. Not pushed when you batch recover data.

The followings are the definition of the data structure:

Parameters	Description
op	Push events, including data_create, data_update, data_remove, and data_recover.
data	Specific data contents

1. Data submitting/data updating/data recovering

Field Comparison Table and JSON Example on the configuration interface for data push can be used as a reference for the format and content of the current form push data.

The comparison table between Jodoo form fields and data types below is as follows:

Field Type	Data Type	Notes
Single Line	string	/
Multi Line	string	/
Serial No.	string	When you create a Serial No. field in a form with data, the field is empty.
Number	number	/
Date&Time	string	/
Radio	string	/
Checkbox	array	/
Single Select	string	/
Multi Select	array	/
Divider	/	Not pushed
Image	array	The URL included in the webhook is an image link, which will expire in 15 days.
Attachment	array	The URL included in the webhook is an attachment link, which will expire in 15 days.
Signature	json	The URL included in the webhook is a signature link, which will expire in 15 days.
SubForm	array	/
RelatedQuery		Not pushed
RelatedData	json	/
Member	json	Status: -1 - Inactive 0 - Pending 1 - Active
Members	array	Status: -1 - Inactive 0 - Pending 1 - Active
Department	json	/
Departments	array	/
Workflow Status (workflow forms only)	number	2 - Manual Close 1 - Done 0 - In Progress
Form Name	string	/
daata_id	string	/
Created User	json	Status: -1 - Inactive 0 - Pending 1 - Active
Updated User	json	Status: -1 - Inactive 0 - Pending 1 - Active
Deleted User	json	Status: -1 - Inactive 0 - Pending 1 - Active
Created Time	string	Use UTC timestamps. Handle them according to the timezone you are in.
Updated Time	string	Use UTC timestamps. Handle them according to the timezone you are in.
Deleted time	string	Use UTC timestamps. Handle them according to the timezone you are in.

Note: When you deal with data, empty values may take different forms depending on the data type. For instance, when a string type data is empty, it may either be null or an empty string. Similarly, when data is in JSON format and is empty, it may be null or an empty JSON object.

b. Data Deleting

Field	Field Type	Description
formName	string	Form name
_id	string	Deleted ID
deleter	json	Deleted user
deleteTime	string	Deleted time

Failed Push

When data push fails, the admin will receive notifications. If the number of failed pushes reaches 100, the function will be disabled, and the admin will receive a message notifying them so. To continue the data push, the admin needs to restart the data push in the data push settings.

The admin can choose to retry pushing the data that is stored in the failed cache, or abandon the cache.

Push History

On the data push page, click Push History to view the successful/failed push. You can also click View Details to view more details.

The system retains only the last six months of push records in Push History.
You an filter and query the push records by selecting Push Success History, Push Failure History, or All.
In Push History, you can view the time, address, and result of each push. In the event of a push failure, the admin can also click View Details to figure out the cause of the failure.