Webhook payload

This option lets you add payload for Webhook. The structure of the payload you add here should be similar to the one that the webhook is expected to receive in future. IBM webMethods Integration uses this data to display the output of the webhook in the subsequent actions of your workflow.

Note:
  • Click Webhook Payload and Log Data for information on the maximum webhook payload and log data supported by IBM webMethods Integration on Amazon Web Services and Microsoft Azure.
  • The webhook payload data added in the source workflow is not retained when the workflow is cloned, imported, or deployed. You will need to reconfigure the webhook settings in each cloned, imported, and deployed workflow.

To configure webhook payload, click the Next button.

There are two options through which you can add webhook payload:

  • Fetch Webhook payload automatically
  • Add Webhook payload manually

Method 1: Fetch Webhook payload automatically

You can use this method to send realtime webhook payload through Postman or browser. This allows you the flexibility to send custom realtime webhook data at the time of sending the request to webhook through any app capable of making REST API requests (like Postman) or any browser.

To do this, follow the instructions given below:

  • Copy the randomly generated Webhook URL.

  • Paste this Webhook URL in any webhook provider that is capable of sending POST requests. Here in our example, we will be using Postman. Enter the details in Headers and Body as per your requirement and then click on the Send button. Once you do that, you will see the following window:

Note: Only JSON is supported. While configuring the request, ensure to provide the request body in JSON format and set the content-type to JSON (Application/JSON).

  • Next, navigate back to the Webhook configuration window in IBM webMethods Integration and click on Fetch to retrieve the Webhook payload data. On clicking the button, the Headers, Body, and Query fields will get autofilled with the data you sent through Postman.

  • Once you are done with this, click Next.

Method 2: Add Webhook payload data manually

Using this method, you can manually add webhook payload data. However, you will have to ensure that the structure of the payload you add is similar to the one that the webhook is expected to receive in the future. IBM webMethods Integration uses this data to display the output of the webhook in the subsequent actions of your workflow.

To do this, in the Webhook page, enter the payload data in the text fields, Headers, Body, and Query, in JSON format.

After you are done with this, click on Next.