To configure the Quick Workflow to send Webhook notifications to a target URL, select the Webhook tab on the Quick Workflow Details screen.
Populate the following and press
.
Target Url: Specify the URL or listener endpoint in another system, of where the configured webhook will be sent.
Body: Specify the contents of the webhook intended for the receiving system. This should have sufficient information to form a request sent back to the system which initiated the webhook and should be kept at a high level e.g. Assignment ID, Employee ID and other identifiers used to describe an Employee, Authorization ID, etc. Personally Identifiable Information (PII) should not be included in the body.
Webhook Profile: Select a Webhook Profile from the drop down list that stores the authentication credentials required by the receiving system. Profiles are configured on the Webhook Profile tab on the API Subscription Manager page.
Notes about creating the webhook body:
Use <br /> to insert a line break.
Include other merge fields by clicking the Merge Data Fields Documentation link and copying the appropriate Merge Document Data Field(s) from the list.
When using fields from a User Report, create the merge code by prefacing the field’s Column Caption with EQ_ and typing the Column Caption exactly how it displays in the User Report. For example, if the Column Caption is “Create Date”, the merge code would be “&EQ_Create Date”. If the Column Caption is “DESCRIPTION’, the merge code would be “EQ_DESCRIPTION”.