Configuring webhooks
Webhooks allow you to start workflows from external systems in real time. Learn how to configure webhooks.
Before you begin
Procedure
- Open the workflow and add Webhook as a trigger.
- To add a webhook trigger, hover over Start and click
Settings or double-click Start. From the list of
trigger services that appear, click Webhook, and then click
Next. You see the webhook configuration window.
- Configure webhook payload Define a sample payload (usually in JSON format) to simulate incoming data. This payload helps webMethods Integration understand the structure of the data and you can map it to variables in your workflow.
- Click Next.
- Optional: Configure webhook authentication. Select a webhook authentication method to enhance security of your webhook data.
- Optional: Enable Auto connect Return Sync on
Webhook. If you want to fetch the workflow output and send it back to the webhook, enable Auto connect Return Sync on Webhook. For more information see
- Click Next. You can view the webhook URL and the payload data that can be used for workflow configuration.
- Click Done. With this, you successfully configured a webhook for your workflow.
- Test the webhook Use tools or systems that can send HTTP POST requests to the webhook URL and verify that the workflow is triggered and the payload is received correctly.
- Build the workflow logic Add actions, for example, data transformation, API calls, database updates based on the incoming data. Use the mapped variables from the webhook payload in your logic.
- Save and enable Save the workflow and ensure that it is enabled so it can respond to incoming webhook calls.