WebHook
What is WebHook
WebHook is an event notification mechanism implemented through HTTP requests. ILLA Flow allows users to trigger workflows in ILLA Flow by making an HTTP request to its WebHook and retrieve the returned data.
How to use it
Body params
Used to set the parameters required in the request body when making a request to this WebHook.
| Property name | Description |
|---|---|
| Key | The parameter names. |
| Type | Used to set the data type. |
| Required | Used to set whether this parameter is required. |
| Test value | Used to enter test values. If your parameter type is String, you can directly enter the String. If your parameter type is another type, you need to enclose the test value in{{}}. For example, for a numerical parameter, you need to enter{{5}}, and for an array parameter, you need to enter{{[1,2,3,4]}}. |
How to request
Copy cURL to get the content required when making a request to this WebHook.
Here is an example,
curl -X POST
https://cloud-api.illacloud.com/flow/api/v1/webhook/workflows/ILAex4p1C7Wm/run?webhookToken=xxxxxx
-H "Content-Type: application/json"
-d '{"param":{"a":1,"b":2},"param1":[1,2,3]}'
cURL includes the following content:
| Field | Description | How to use in the REST API Action of ILLA |
|---|---|---|
| Request method | POST | Action type |
| URL | The part before the question mark is the requested URL. For example,https://cloud-api.illacloud.com/flow/api/v1/webhook/workflows/ILAex4p1C7Wm/run | Base URL |
| Query parameters | The part after the question mark is the requested URL. For example,webhookToken=xxxxxx | URL Parameters |
| Header | Content-Type: application/json | Headers |
| Request body | If you have set a request body in the WebHook, the cURL command will include an example of the request body. | Body, it could bex-www-form-urlencodedorRaw - JSON |
How to get the response
Learn more about response: https://docs.illacloud.com/illa-flow-response