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

Configuring a webhook callback for external applications

BMC Helix Platform supports webhook callbacks in an external application (only Adobe Sign is supported for now), so that the platform receives real-time notifications whenever an event takes place in the external application. These notifications can then be used to trigger specific rules or processes.

For more information, see Example of webhook callback in external applications. 

Note

If you want to use the Adobe Sign callback configuration in multiple applications, you must create a new configuration for each application. 

Before you begin

To configure the webhook callback

  1. Log in to BMC Helix Innovation Studio and navigate to the Administration tab. 
  2. Select Webhook Connection > Callback Configuration > Webhook Callback Configuration. 
  3. On the Webhook Callback Configurations page, click New configuration. 

  4. On the Create New Callback Configuration page, in Configuration Name, type a meaningful name for this configuration. 
    Example: Webhook-for-Adobe

    Tip

    For the callback configuration to work correctly, the configuration name must be the same in the development, QA, and production environments.

  5. From the Bundle Name list, select the name of the application for which you want to use the Adobe Sign webhook callback.
  6. From the Processor list, select Adobe Sign. 
  7. In X-ADOBESIGN-CLIENT ID, enter the Application Id that you received earlier.
    In Callback U    RL, the URL is populated automatically.
  8. Click Save.


The following image is an example of configuring a webhook callback:

Adobe webhook callback config.png

To add the webhook URL in Adobe Sign

After you have configured the webhook callback for Adobe Sign, you must add the webhook URL (callback URL) in Adobe Sign so that you can select the events in Adobe Sign for which you want to receive the notifications. 

in Adobe Sign, you can register webhook in the following ways:

  1. Log in to Adobe Sign. 
  2. Click the Account tab. 
  3. Select Webhooks, and click Create new webhook icon.png Create a new webhook. 
  4. On the Create page, in Name, enter a name for the webhook. 
    Example: Webhook-For-Adobe 
  5. From the Scope list, select Account.
  6. In Url, type the Webhook URL that is displayed when configuring the webhook callback. 
  7. From the Events list, select the events in Adobe Sign for which you want to be notified. 
  8. In Notification Parameters, select the check boxes corresponding to the parameters for the selected events. 
  9. Click Save. 
    The settings are saved only if the Webhook URL is valid and publicly accessible.


You have configured the Adobe Sign webhook callback in BMC Helix Platform and selected the events for which you want to be notified. You can use this configuration to trigger a rule to perform certain actions in an application developed on BMC Helix Platform after the selected events occur in Adobe Sign.

Learn how to trigger a rule based on a webhook callback. 

Troubleshooting the webhook callbacks

The Webhook Callback Entry Data record definition contains the audit information of callbacks coming from the external application.

To view the audit data, in the Workspace tab, select the application in which you are using the webhook callback and select Records > Webhook Callback > Edit Data. 

Related topic

Registering-a-webhook-with-BMC-Helix-Platform-to-get-real-time-event-notifications

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*