Webhook Usage Guide
Using webhook to communicate between two software
Webhook
A webhook is basically a notification event that is sent to a selected information URL. In fact, web hook is a way to establish automatic communication between two software.
As soon as an event occurs, the path of the inserted URL will be called.
Webhook is used to integrate and unify the functionality of several software with each other.
The noteworthy point is that the use of webhooks requires programming knowledge.
Web hook in formican
The use of web hook is created with the purpose of communicating between different software with formican. In this way, if a user registers a form using the form builder, the form information is sent to the software whose link is placed in the formican web hook settings.
How to connect to formican
In order to set up the web hook through formican, from the integration tab and in the web hook menu, three URL address receiving boxes can be filled:
Internet address for receiving information registration event:In order to send the form information after "registering", the address of the destination software service is noted in this box.
Internet address for receiving information editing event: In order to send form information after "editing", the service address of the destination software is noted in this box and information with the following structure is sent to the destination software.
The data structure of the form registration and editing event is the same as follows:
{
"form":{
"form":{
"id":"ID of the filled form",
< div>"formId":"Form ID","formattedId":"proprietary ID",
"creatorId":"Creator user ID",
"creatorName":"creator's username" span>,
"createDate":"date of registration",
"editorId":"Editor ID",
"editorName":"Editor Name" span>,
"editDate":"edit date",
"custCode":"Customer ID",
"custName":"customer name",
"urlReferrer":"Web address of registration form",
" browser":"browser name",
"ip":"IP",
"coordinate":"geolocation",
"params":[ //an array of form field parameters
{
"fieldId":"Field ID",
"title":"text value",
"value":"value",
"number":"numerical value",
"group":"parameter group"
}
]
}
}
Internet address to receive data deletion event: When a form is deleted, the address of the destination software service written in this box will be called and information with the following data structure will be sent.
{
"ids":[ //array of registered data identifiers
"Removed Form ID"
]
}
And with the completion of each of the above events, a notification call will be sent to the entered internet address with the POST method.
With the web hook capability of formican form builder, you can easily communicate with other software.