Webhook & Webhook Response
Webhook & Webhook Response provides real-time, two-way integrations with external systems. Pair a Webhook listener with a Webhook Response to receive, process, and reply to external events all within a single flow.
Accept live notifications and payloads from any external system the moment they occur.
Start automation flows immediately when an event fires.
Send dynamic status codes and response bodies back to the originating system.
Adding a Webhook listener
Click the + icon
From Select System, select Built-in Function, then Select Webhook
Configure fields
Click Save
Webhook Configuration
| Field | Description | Required |
|---|---|---|
| System | The external platform that will send data to this webhook. | Required |
| Webhook Name | A human-readable label to identify this trigger inside your flow. | Required |
| URL Suffix | The path appended to your base URL, e.g. /orders or /item_updated. No spaces allowed. | Required |
| Public URL | Auto-generated full URL. Click + to generate it, then use the copy icon to share it with your external system. Disabled for manual entry to prevent typos. | Auto-generated |
| HTTP Method | Allowed methods for incoming requests: POST, GET, DELETE, PATCH. | Required |
| Authentication | Security protocol required to access the endpoint, e.g. API Key. Automatically populates relevant headers. | Required |
| Body Format | The format of the incoming request body. Choose JSON (default) or XML. 1. When set to XML, Studio parses the incoming XML payload and makes it available as structured variables for downstream mapping. 2. The same way JSON payloads work. Saving a webhook with an XML body while the format is set to JSON will fail validation. | Required |
The Webhook URL suffix cannot contain spaces. Including one will cause the system to return an error. Use hyphens or underscores instead, e.g. /item-updated.
Click the copy icon next to the Public URL. Use the copy icon to paste the full URL into your external system. This field is locked from manual editing to prevent configuration errors.
Expected Data Structure
Define the shape of data the webhook will receive. These fields become available as variables on the mapping page later in the flow.
| ● Headers Define critical headers. When API Key auth is active, these are populated automatically. | ● Query Parameters Specify expected Keys and Values that may arrive as URL query strings. | ● Body The main data payload. Optional, but defining its structure enables testing and variable mapping downstream. |
Live data doesn't have to strictly match the structure you define. Specifying it here prepares your webhook variables for downstream mapping and enables simulated test data during development.
Adding a Webhook Response
Click the + icon
From Select System, select Built-in Function, then Select Webhook Response
Configure your status code, headers, and response body
Click Save
Webhook Response Configuration
| Field | Description |
|---|---|
| Status Code | The HTTP status to return to the caller. Choose from 200 OK, 201 Created, 202 Accepted, or 204 No Content. |
| Override status code | Enable to dynamically override the response code for failed or conditional requests useful for surfacing errors to the calling system. |
| Headers | Custom key-value header pairs to include in the reply, e.g. Content-Type: application/json. |
HTTP Status Code Reference
200 OK Standard success request received and processed. | 201 Created A new resource was created as a result of the request. |
202 Accepted Request accepted for processing, but not yet completed. | 204 No Content Success with no response body to return. |
Related Articles