2022

Page tree

Versions Compared

Key

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

Overview

Organizations might find it hard to keep track of the various processes in progress or errors that might occur. Email notifications for when a process is complete is currently provided as an in-built feature but might not be sufficient to keep track of errors, or start, and finish of a process. Also receiving notification within the server of the company or any communication channel such as Slack can be extremely beneficial to the users to keep track of all events. It is also very essential for the user to be notified about the three most important stages of an activity:

...

  • There is a specific list of supported expressions which has to be followed for writing the various required parameters in the URL while running the GET method.

  • These can be found listed under “Supported Expressions”. Various conditions for these parameters can also be listed. 

  • Once you enter all parameters Click SAVE

  • Click Test Connection

  • A pop-up confirming webhook connection will appear on the screen

Image Modified

  • In below image:

  • A notification stating the process has started has been received

  • Error count if any

  • Date and time

...

  • Test button - to test the operation of notification

    • For Post, just post the post body as is

  • Phase 1 - we will document the parameters available on Wiki

  • Phase 2 - we will allow them to pick and choose the variables from the UI

  • All the above values captured will be part of properties and will be saved in config.properties

Supported Expressions:


Option

Expression

Notes

Current date

$date; format=”dateformat”$

Format is an optional attribute. However, it is recommended to add one.

Do NOT escape quotes in dateformat as it can lead to errors.

Current event

$event$

Values: Started, Errored or Completed

Error count

$errorCount$

Denotes the number of objects that encountered an error

Is error in backup

$isError$

Values: true if event is errored else false

Profile Name

$profile$


Total records processed

$recordsProcessed$

Total number of records processed ie. inserted + updated for all objects


...