- Navigate to Webhooks on the Rest Service Maintenance Page
- Enter a name for the Webhook.
- Click the Edit Webhook button to open the webhook settings.
Settings
Name – The name of the current webhook.
Webhook type – Choose how the webhook will send data.
- Callback contains links
- Use this option if the webhook only contains some data which needs to be used to link to another existing data source to retrieve all the required data.
- Use this option if the webhook only contains some data which needs to be used to link to another existing data source to retrieve all the required data.
- Callback contains data
- Use this option if the webhook supplies all the data you need.
- Use this option if the webhook supplies all the data you need.
Data Source – Choose which existing data source to use when the webhook type is using links. The fields will be added automatically from the linked source and can’t be changed. If the webhook type is set to callback contains data, this will add the fields from the linked source and will allow the fields to be changed, but data will not come back from the linked source.
Body type – Choose the type of body the webhook will use.
Callback Setup
- Callback parameters – Used to store data from a callback.
- Variable – Select which variable will store the data.
- Source – Choose where the data is coming from.
- Value – Enter the Value, Path or Key that contains the data.
- Callback Events
- Event Setup
- Callback does not contain event type – no addition settings. The webhook source will trigger for any event type.
- Callback contains event type – If the callback contains information about what type of event has occurred, this can be setup to trigger accordingly.
- Event Type source – Select where the event type is coming from and set the Path or Key
- Allow Create – Enable to allow create registration on the real time source associated to this webhook.
- Allow update – Enable to allow update registration on the real time source associated to this webhook.
- Allow delete – Enable to allow delete registration on the real time source associated to this webhook.
- Event Setup
Callback Response
Define what SmartConnect sends back to the API when required.
- Success status code – Set the response code if the webhook was successful.
- Failure status code – Set the response code if the webhook failed.
- Body – Enter a body to send with the response.
- Insert Callback Parameter – Quickly choose parameters previously setup.
- Insert Callback Parameter – Quickly choose parameters previously setup.
- Header Key – Name of the header to send in the response.
- Header Value – Value of the header to send in the response.
Callback Fields / Data Source Fields
Webhook type contains data – Define the fields from the webhook that SmartConnect will display when used as a source.
- Load from file – choose a file that contains the field structure instead of manually defining them.
- Clear all – Removes all defined fields.
Webhook type contains links – These fields will not be editable as they are pulled in and defined from the linked source.