Webhooks are "user-defined HTTP callbacks". They are usually triggered by some event. When that event occurs, the source site makes an HTTP request to the URL configured for the webhook. Users can configure them to cause events on one site to invoke behavior on another.
Where can it be used?
It can be used in case of Form submit, It will make an external HTTP call to pass the submitted form information to a third party.
Note: It is not available for competition forms.
How to use it?
Login to the TractionNext.
- Navigate to the Automation module on the top menu.
- In the left pane, click on the ‘Webhooks’ option.
- Now click on the ‘Create Webhook’ button.
It displays the below screen where you need to fill the required details.
Name: Enter the name of the webhook.
Description: Enter a description for the webhook.
Active: Check this box if you want to activate it while creating it.
Webhook type: Select the webhook type from the dropdown i.e. Single Form OR All Forms. Also, select the format as JSON or XML or Azure Queue.
Trigger on Form: Select the form from the dropdown. This option is unavailable when you select ‘All Forms’ as a webhook type.
Receiver URL: Enter the receiver's URL. It is the target file where your form submitted data will be handled/processed. e.g.
Clients will have to set up their own receiver URL.
Points to be noted:
- Using SSL (https) is required.
- We strongly recommend:
- Keep your receiver URL private
- Include a security token or secret key in your URL, and validate it at the receiver
Now, click on the ‘Save’ button. Your webhook has been created.
Show me a sample:
It shows you a sample of webhook code in the format you selected while creating the webhook (i.e. JSON, XML or Azure queue).
It depends on the webhook name, Receiver URL and Form ID.
How to delete a webhook?
Click on ‘Webhook’ under the Automation menu. It will display the following screen…
Click on Edit -> Delete. It will delete the webhook.
Webhook Activity Report
To get the webhook activity report, click on Edit -> Activity. It will display the following screen…
We can export this report by clicking on the Export Report button shown in the above screen.