Webhooks - New functionalities from v6.10

Owned by lakshmi sujatha gajjarapu
Sept 02, 2022
3 min read

Do Not Unsubscribe

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. 

Alerts Menu Item

  • Webhooks is moved out from Setup to Alerts Menu Item on VMS web

  • Alert menu item has two inclusions - Webhooks and Notifications

    • Webhooks - shows the list of subscriptions made by the user if the user is a non-administrative role and shows all the subscriptions in the system for an administrator user

    • Notifications - shows the list of Notifications for all the subscriptions visible for the user.

       Webhooks 

  • Clicking one of the rows in webhooks, opens the webhook subscription drawer with three tabs - Overview, Notifications and Comments

    • While Overview  has some new additions to it, Comments remain the same from before.

    • Notifications tab in the subscription drawer includes the list of notifications filtered for the selected subscription.From 6.10.0, this list is updated to be similar to the other lists on VMS web with enabled filters and sorting.

    • Further clicking on one of the rows in the notifications list on subscription drawer, we can see the details of the Notification Msg sent for the subscription along with the error msg if the msg sending failed.

     Notifications

  • Holds the list of notifications for those subscriptions which the user has access to.

    • Administrator can access all the notifications for all the subscriptions available in the system, while non admin users can access only the subscriptions for the given logged in user. For example,

Template_msg

The possibility for the user to define a message template that should be used when sending notifications for a webhook subscription is introduced.

In order to use this, the user when creating a webhook subscription should provide the necessary input to the field/attribute “templateMsg". Make sure the placeholders are indicated by a '?' followed by the field/attribute directly accessible from the root object type on which the subscription is being made.

For example, when creating a subscription on Bank object , the user can use template_msg like ‘Bank with Name ?bankName is changed by ?changedById’ .

This would result in the below notification for the user (example data, for reference only)