User Interface - Webhook

General Information about Webhooks

Webhooks (sometimes referred to as “Event Calls” or “Event / API Triggers”) are event-driven API calls that are generated by systems when a specific condition is met in that system.

When a specified event is triggered (for example, updating a data field or deleting a file/record in a system), the system calls a specified URL with the information that was selected when the event was configured.

OneTeg flows can be configured to start it's flows with the sent webhook trigger and use the data sent via the webhook.

Webhooks can only be set as the starting step of each flow, so that when an event is triggered on the external system, the data or webhook package is sent to OneTeg, starting this flow, and OneTeg also receives the information in this package, which can be used in the following steps.

User Interface - Webhooks

The Webhook page acts like the Activities page and provides a quick overview of which flow was triggered by a webhook, what time the webhook request was received, and whether the flow was successful when it completed its execution.

You can also review the packet data received by the Flow by clicking the Options button and selecting Payload.

You can also review the information received by going to the Flow page and reviewing the output data of the webhook step.

How to Setup a Webhook to be used in a Flow

To set up a flow to receive and be triggered by a webhook, simply create a new flow and select "Webhook" as its first step.

When the flow is saved, a webhook URL is generated in the step.

You can copy this URL for use by the external system. You can also use the highlighted "Copy URL" button.

When the event is triggered by the external system, the OneTeg Flow will also receive the information according to the configuration made on the external system and the OneTeg Flow will start to run.