This documentation supports the 20.08 version of BMC Helix Platform. 
To view an earlier version, select 20.02 from the Product version menu.

Adding webhooks

BMC Helix Platform provides the webhook definition—an HTTP callback mechanism to receive real-time event notifications. The webhook definition eliminates the manual efforts required to create a rule and saves the time consumed by continuous API polling. 

As an administrator, you can register a webhook with BMC Helix Platform to get real-time notifications. You can also use webhooks registered with external applications such as Adobe Sign and DocuSign in applications developed on BMC Helix Platform. 

Webhooks in BMC Helix Platform

Developers can register a webhook with BMC Helix Platform to receive notifications or data when an event occurs in a record definition, such as create record, update record, or delete record. This saves the time to keep polling on the record definition. 

Example of registering a webhook with BMC Helix Platform

An organization uses the following applications that are integrated with each other: 

  • BMC Helix Business Workflows developed on BMC Helix Platform—Agents create cases.
  • Atlassian Jira (for project tracking)—The external system that listens for events in BMC Helix Business Workflows.
  • BMC Helix Integration Service—Integrates BMC Helix Business Workflows and Atlassian Jira.

Use a webhook definition when you want Jira Issues to be updated in real time, whenever an agent creates or updates a case in BMC Helix Business Workflows. Register the BMC Helix Integration Service URL to get callback from BMC Helix Business Workflows every time a case is created. You can then use the callback data to create or update a corresponding issue in Jira. 

Webhooks in external applications

An administrator can configure the webhook callback for an external application. An application business analyst can use the event details from the supported external applications to trigger a rule and a process in an application developed on BMC Helix Platform. 

The following external applications are supported:

  • Adobe Sign
  • DocuSign

Example of webhook callback in external applications

An organization uses the following applications that are integrated with each other:

  • BMC Helix Business Workflows developed on BMC Helix Platform—For the HR line of business. This application listens for events in Adobe Sign.
  • Adobe Sign—A third-party application to digitally sign the HR documents.

Configure the webhook definition of Adobe Sign when you want BMC Helix Platform to get a notification when a document is digitally signed in Adobe Sign. This notification is sent to BMC Helix Business Workflows to trigger a rule to change the document status to Signed.

Where to go from here

ActionReference

Register a webhook with BMC Helix Platform

Registering a webhook with BMC Helix Platform to get real-time event notifications
Configure the webhook callback for external applicationsConfiguring a webhook callback for external applications


Was this page helpful? Yes No Submitting... Thank you

Comments