2022

Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • From the Top Navigation toolbar Click on NOTIFICATIONS:

  • Select Webhooks Configuration- CHANGE SCREEN

Image Removed

  • Check boxes to receive notifications for events- CHANGE SCREEN
    1. Started

    2. Completed

    3. Errored

Image Removed

  • 'Webhooks' as the channel type and the settings will appear on the screen as seen in the below image:

Image Added

Configure Webhooks Notifications Settings

  1. Receive Notifications 
    Click the check-box next to the desired event options. There are 3 main event options that can be configured are shown in the image below:

Image Added

    • Process  
    1. Started- Click the check-box next to the icon 'Started' if you wish to be notified when a process is started. For eg: If you enable this option you will be notified when a process such 'Clean Copy', 'DB to Source' etc starts running. 

    2. CompletedClick the check-box next to the icon 'Completed' if you wish to be notified when a process is completed. For eg: If you enable this option you will be notified when a process such 'Clean Copy', 'DB to Source' etc completes. 

    3. ErroredClick the check-box next to the icon 'Errored' if you wish to be notified when error arrears in the process or the process fails. For eg: If you enable this option you will be notified when a process such 'Clean Copy', 'DB to Source' etc encounter errors or fails. 

    • Object  
    1. Added- Click the check-box next to the icon 'Added' if you wish to be notified when any new object is detected in your Source or Database. For eg: If you enable this option you will be notified when any new object such as 'Account' , 'User' etc is detected on your Salesforce or your Database instance. 

    2. UpdatedClick the check-box next to the icon 'Updated' if you wish to be notified when any change in the object is detected in your Source or Database. For eg: If you enable this option you will be notified when any change in the object such as 'Account' , 'User' etc is detected on your Salesforce or your Database instance. 

    3. RemovedClick the check-box next to the icon 'Removed' if you wish to be notified when an object is removed/deleted from your Source or Database. For eg: If you enable this option you will be notified when an object such as 'Account' , 'User' etc is removed or deleted from your Salesforce or your Database instance. 

    • Fields
    1. AddedClick the check-box next to the icon 'Added' if you wish to be notified when any new object field is detected in your Source or Database. For eg: If you enable this option you will be notified when any new object (Account) field ( 'Billing Street'),(Billing City) etc is detected on your Salesforce or your Database instance. 

    2. UpdatedClick the check-box next to the icon 'Updated' if you wish to be notified when any change in the object field is detected in your Source or Database. For eg: If you enable this option you will be notified when any change in the object  (Account) field ( 'Billing Street'),(Billing City) is detected on your Salesforce or your Database instance.

    3. RemovedClick the check-box next to the icon 'Removed' if you wish to be notified when an object field is removed/deleted from your Source or Database. For eg: If you enable this option you will be notified when an object (Account) field ( 'Billing Street'),(Billing City) etc is removed or deleted from your Salesforce or your Database instance. 


  1. Methods of Configuration Notifications 

There are 2 methods you can use to configure Webhooks:- CHANGE SCREEN (DUE TO NOTIFICATION SCREEN CHANGE)

  1. GET method:

Image RemovedImage Added

  • This method is used if you want to use your own API to get notified using webhooks

  • From the URL drop-down menu choose the GET method option.

  • URL (supporting variable injection) - notification.webhook.url

  • This method allows parameters in URL

  • Example of a URL for Get method:

...

b. POST method:   CHANGE SCREEN (DUE TO NOTIFICATION SCREEN CHANGE)-CROP

Image RemovedImage Added

  • This method is used if the user wants to define the payload.

  • From the URL drop-down menu choose the POST method option.

  • The following screen will pop-up.

  • Fill all the details : URL, HEADERS, CONTENT TYPE and PAYLOAD

Image Removed

For example:

Let us consider that a user wants to get notified in SLACK. 

...