Skip to main content

Trigger Mode – Trigger by Webhook

Overview​

A Webhook enables external applications to send real-time data to this application.

When an external system sends an HTTPS request to the Webhook URL, the Webhook server automatically triggers a workflow. Within the workflow, you can create or update data in a worksheet, enabling seamless data integration with other systems.

In short, workflows triggered by Webhook allow you to automatically receive data from external applications or services.

How to Receive Data / Trigger a Workflow​

Each workflow triggered by Webhook automatically generates a unique URL.

External applications simply need to add this URL as a callback (push) address to automatically send data to your application.

Whenever the Webhook URL receives data, the system automatically parses the fields and triggers the workflow.

Parse and Generate Sample Data​

During the initial configuration, you must first create a data sample. Subsequent incoming requests will be parsed according to this sample and can then be used within the workflow.

Parsed parameters can be set as required. If a required parameter is missing in the external request, the system will return the following error message: "msg": "Missing required parameter".

Generate from Request Example​

After selecting this method, you must send a GET or POST request to the URL within 3 minutes.

Once data is received, it will be parsed automatically.

Below is an example showing automatically parsed data after receiving a request:

Generate Full Body Parameter

If enabled, the entire request Body content will also be generated as a single parameter.

Generate from JSON Example​

Parse data based on a predefined JSON format.

Generate from Key-Value Pairs​

Use Incoming Data​

After confirming the sample data, subsequent nodes in the workflow can use the transmitted parameters.

Response Settings​

After an external application sends a request to the Webhook, you can customize the response method and returned content under [Workflow Configuration] > [AI Capabilities].

Security​

By default, anyone who obtains the Webhook URL can send requests. To enhance security, you can enable the following options:

  • Request Authentication

    Enable “Use App Authorization” to require the request parameters to include AppKey and Sign.

  • App IP Whitelist

    Only IP addresses included in the whitelist are allowed to send requests.

TIPS​

In the list of workflows triggered by Webhook, you can quickly locate a workflow by searching for the ID in the Webhook URL.

Enabled Webhook-triggered workflows will also appear in the application's API documentation.