Webhook Notifications with API
When the DataShare API product is enabled the option to use a webhook for notifications is available. Notifications will be sent out whenever there is a change in status for an upload.
To access the Webhook settings, select your user account at the top right-hand side and click on Settings.
On the left-hand side, select Integrations, and then the Webhook option.
Users with appropriate permission will be able to set up the configuration in the System Configuration section of Datashare Admin.
You will be able to set the following configuration:
- Webhook On/Off switch
- Webhook URL – Set the URL including the correct protocol of where the notification will be sent to
The format of the notification will be:
The fields will have the following details:
event – This will be UPLOAD as currently the only webhook service we are supplying will be on the change of Upload status.
status – This is the upload status and will be one of the following: LOADING, ABORTED, PROCESSING, FAILED, or COMPLETED.
clientId – This is your unique identifier.
engagementId – This is the unique identifier for the engagement.
uploadId – This is the unique identifier for the upload.
apiUrl – This is the root URL to use when requesting data via API.
Once the changes have been made, click on 'SAVE' to save the changes.