Configuring webhook payload

A webhook payload is the data that is received from an external system to a webhook URL in webMethods Integration when an event occurs. This payload is typically in JSON format and contains key-value pairs that represent the event details or data you want to process.

About this task

Configuring the payload helps webMethods Integration understand the structure of the incoming data so it can be correctly mapped to variables in your workflow. You can add a payload for a webhook by using the webhook payload option. The structure of the payload you add here must be similar to the one that the webhook is expected to receive in future. 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 that is supported on Amazon Web Services and Microsoft Azure.
  • The webhook payload data that is added in the source workflow is not retained when the workflow is cloned, imported, or deployed. You need to reconfigure the webhook settings in each cloned, imported, and deployed workflow.

Procedure

  1. To configure webhook payload, select the webhook trigger and click Next.

    The following are the options through which you can add the webhook payload:

    Fetch Webhook payload automatically
    You can use this method to send real-time webhook payloads through any tool that supports sending HTTP requests or a browser. It offers the flexibility to send custom real-time data when you send requests to the webhook. You can use any application that supports REST API calls, such as Postman or a browser.
    Add Webhook payload manually
    You can use this method to manually add webhook payload data. However, you must make sure that the structure of the payload you add is similar to the one that the webhook is expected to receive in the future. webMethods Integration uses this data to display the output of the webhook in the subsequent actions of your workflow.
  2. Do the following steps to retrieve the webhook payload automatically.
    Note: If you want to add the webhook payload manually, skip this step and go to step 3.
    1. Copy the randomly generated webhook URL.
    2. Paste this webhook URL in any webhook provider that can send POST requests.
    3. Enter the details in Headers and Body as needed and then click the Send button.
      Note: Only JSON is supported. When you configure the request, provide the request body in JSON format and set the content-type to JSON (Application/JSON).
    4. Return to the Webhook configuration page in webMethods Integration and click Fetch to retrieve the webhook payload data.
      The Headers, Body, and Query fields are autofilled with the data you sent.
    5. Click Next.
  3. Do the following steps to add webhook payload data manually
    1. In the Webhook page, enter the payload data in the text fields, Headers, Body, and Query, in JSON format.
    2. Click Next.

What to do next

After the payload data is configured, you can set an authentication method to enhance webhook security.