Tip |
---|
Webhooks are available from version 3.3 of the Dataloy API |
...
Note |
---|
Automatic Deactivation of subscription If the subscribing system is unavailable or takes too long to respond, the server will deactivate the subscription after attempting 5 times (once a minute). The number of attempts and the interval between each attempt can be configured. Deactivated subscriptions cannot be reactivated, a new subscription must be created if needed. Email alert when a subscription is de-activated: Add the desired email address (e.g. to the IT ops team) to the API user (in User Administration) to receive an email notification if a subscription is de-activated.receive an email notification if a subscription is de-activated. From, version 6.10, there is a possibility for the users to choose not to deactivate the subscription even after the max failed attempts.This is made possible through the checkbox "Do Not Unsubscribe" when creating a webhook subscription on VMS. Ticking the checkbox means that the subscription will not be unsubscribed and deactivated automatically after the max failed attempts. If using API endpoint to create/update subscription, the input curl should include the attribute and value as in { "doNotUnsubscribe": false/true } |
The message sent to the subscribed endpoint is set in the body of the POST method. The message is a JSON object and has the following structure:
...
A new attribute xsl has been added which allows you to store an XSL stylesheet to transform the subscribed object to XML. The value of the field must be encoded with Base64. This is part only of Enterprise API.
...
.
...
A new attribute, called doNotUnsubscribe (type boolean), has been added to prevent that the subscription will get unsubscribed, also if the endpoint is not reachable for more time of the max time of attempts set for the given server.
Supported Methods
GET /WebhookSubscription
...