Skip to main content
POST
/
webhooks
/
{id}
Trigger Workflow via Webhook
curl --request POST \
  --url https://app.splox.io/api/v1/webhooks/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "12345",
  "event": "user.signup",
  "email": "[email protected]",
  "name": "John Doe"
}
'
{
"workflow_request_id": "0199f123-d60e-7ffd-9131-4cc5ab040ee8",
"note": "Webhook received but did not match any event configurations"
}
Triggers a workflow execution by sending data to its unique webhook URL.

Usage

Each workflow has a unique webhook URL that can be called from any external service:
https://app.splox.io/api/v1/webhooks/{webhook_id}

Authentication

Webhooks can be configured as:
  • Public: No authentication required
  • Authenticated: Requires Bearer token or webhook secret

Payload

Send any JSON data - it will be available as input variables in your workflow.

Response

Returns a workflow_request_id that can be used to check execution status.

Path Parameters

id
string<uuid>
required

Unique webhook identifier (UUID format)

Example:

"0199eeeb-d60e-7ffd-9131-4cc5ab040ee7"

Body

application/json

Webhook payload - any JSON data that will be passed to the workflow

The body is of type object.

Response

Webhook processed successfully

Response includes workflow_request_id and echoes back the processed payload

workflow_request_id
string<uuid>

ID of the created workflow request - use this to check execution status

Example:

"0199f123-d60e-7ffd-9131-4cc5ab040ee8"

note
string

Present only if webhook didn't match any event configurations

Example:

"Webhook received but did not match any event configurations"