Webhooks

A webhook is a trigger that allows external applications to start a workflow by sending an HTTP request to a unique URL. It enables real-time, event-driven integration between webMethods Integration and other systems without the need for polling.

Webhooks that allow external sources to notify webMethods Integration about a specific event are known as incoming webhooks.

An overview of the functioning of incoming webhooks is as follows.
  • Webhook trigger - When you create a workflow, you can choose a webhook as the trigger. This webhook generates a unique URL. You need to submit this URL to an external source. This external source can be any web service or app that can make HTTP POST requests.
  • External call - An external system sends data, JSON payload to this URL through an HTTP request (typically POST) to webMethods Integration. This payload contains the details of the event.
  • Workflow run - The incoming data triggers the workflow, which processes the data as defined in your logic.

For example, you can provide the webhook URL to Evernote, and define that the URL must be notified whenever a new note is created in your account. Now, whenever a new note is created in your Evernote account, Evernote sends an HTTP POST request (with details of the created note in its body). The workflow starts.

To summarize, if you create a workflow with the webhook enabled, the workflow runs automatically. The workflow is started whenever an HTTP POST (with payload) or HTTP GET request is sent to the webhook URL.