curl -X POST https://api.hookpulse.io/v1/api/add_workflow_step/ \
-H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
-H "x-brand-uuid: {{x-brand-uuid}}" \
-H "Content-Type: application/json" \
-d '{
"index": {{index}},
"workflow_uuid": "{{workflow_uuid}}",
"webhook_name": "{{webhook_name}}",
"webhook_description": "{{webhook_description}}",
"method": "{{method}}",
"path": "{{path}}",
"domain_uuid": "{{domain_uuid}}",
"human_approval_required": {{human_approval_required}},
"step_identifier": "{{step_identifier}}",
"on_success_next_step_identifier": "{{on_success_next_step_identifier}}",
"on_fail_next_step_identifier": "{{on_fail_next_step_identifier}}",
"delay_to_next_step": {{delay_to_next_step}},
"execution_condition": {
"operator": "{{operator}}",
"field": "{{field}}",
"value": "{{value}}"
},
"retry_delay": {{retry_delay}},
"retry_backoff_mode": "{{retry_backoff_mode}}",
"max_retries": {{max_retries}},
"request_timeout_in_milliseconds": {{request_timeout_in_milliseconds}},
"request_body_json": {},
"headers_json": {},
"query_params_json": {}
}'
const response = await fetch('https://api.hookpulse.io/v1/api/add_workflow_step/', {
method: 'POST',
headers: {
'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
'x-brand-uuid': '{{x-brand-uuid}}',
'Content-Type': 'application/json'
},
body: JSON.stringify({
index: {{index}},
workflow_uuid: '{{workflow_uuid}}',
webhook_name: '{{webhook_name}}',
webhook_description: '{{webhook_description}}',
method: '{{method}}',
path: '{{path}}',
domain_uuid: '{{domain_uuid}}',
human_approval_required: {{human_approval_required}},
step_identifier: '{{step_identifier}}',
on_success_next_step_identifier: '{{on_success_next_step_identifier}}',
on_fail_next_step_identifier: '{{on_fail_next_step_identifier}}',
delay_to_next_step: {{delay_to_next_step}},
execution_condition: {
operator: '{{operator}}',
field: '{{field}}',
value: '{{value}}'
},
retry_delay: {{retry_delay}},
retry_backoff_mode: '{{retry_backoff_mode}}',
max_retries: {{max_retries}},
request_timeout_in_milliseconds: {{request_timeout_in_milliseconds}},
request_body_json: {},
headers_json: {},
query_params_json: {}
})
});
const data = await response.json();
console.log(data);
import requests
url = 'https://api.hookpulse.io/v1/api/add_workflow_step/'
headers = {
'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
'x-brand-uuid': '{{x-brand-uuid}}',
'Content-Type': 'application/json'
}
payload = {
'index': {{index}},
'workflow_uuid': '{{workflow_uuid}}',
'webhook_name': '{{webhook_name}}',
'webhook_description': '{{webhook_description}}',
'method': '{{method}}',
'path': '{{path}}',
'domain_uuid': '{{domain_uuid}}',
'human_approval_required': {{human_approval_required}},
'step_identifier': '{{step_identifier}}',
'on_success_next_step_identifier': '{{on_success_next_step_identifier}}',
'on_fail_next_step_identifier': '{{on_fail_next_step_identifier}}',
'delay_to_next_step': {{delay_to_next_step}},
'execution_condition': {
'operator': '{{operator}}',
'field': '{{field}}',
'value': '{{value}}'
},
'retry_delay': {{retry_delay}},
'retry_backoff_mode': '{{retry_backoff_mode}}',
'max_retries': {{max_retries}},
'request_timeout_in_milliseconds': {{request_timeout_in_milliseconds}},
'request_body_json': {},
'headers_json': {},
'query_params_json': {}
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())
require 'net/http'
require 'json'
require 'uri'
uri = URI('https://api.hookpulse.io/v1/api/add_workflow_step/')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri.path)
request['x-hookpulse-api-key'] = '{{x-hookpulse-api-key}}'
request['x-brand-uuid'] = '{{x-brand-uuid}}'
request['Content-Type'] = 'application/json'
request.body = {
index: {{index}},
workflow_uuid: '{{workflow_uuid}}',
webhook_name: '{{webhook_name}}',
webhook_description: '{{webhook_description}}',
method: '{{method}}',
path: '{{path}}',
domain_uuid: '{{domain_uuid}}',
human_approval_required: {{human_approval_required}},
step_identifier: '{{step_identifier}}',
on_success_next_step_identifier: '{{on_success_next_step_identifier}}',
on_fail_next_step_identifier: '{{on_fail_next_step_identifier}}',
delay_to_next_step: {{delay_to_next_step}},
execution_condition: {
operator: '{{operator}}',
field: '{{field}}',
value: '{{value}}'
},
retry_delay: {{retry_delay}},
retry_backoff_mode: '{{retry_backoff_mode}}',
max_retries: {{max_retries}},
request_timeout_in_milliseconds: {{request_timeout_in_milliseconds}},
request_body_json: {},
headers_json: {},
query_params_json: {}
}.to_json
response = http.request(request)
puts JSON.parse(response.body)
<?php
$url = 'https://api.hookpulse.io/v1/api/add_workflow_step/';
$data = [
'index' => {{index}},
'workflow_uuid' => '{{workflow_uuid}}',
'webhook_name' => '{{webhook_name}}',
'webhook_description' => '{{webhook_description}}',
'method' => '{{method}}',
'path' => '{{path}}',
'domain_uuid' => '{{domain_uuid}}',
'human_approval_required' => {{human_approval_required}},
'step_identifier' => '{{step_identifier}}',
'on_success_next_step_identifier' => '{{on_success_next_step_identifier}}',
'on_fail_next_step_identifier' => '{{on_fail_next_step_identifier}}',
'delay_to_next_step' => {{delay_to_next_step}},
'execution_condition' => [
'operator' => '{{operator}}',
'field' => '{{field}}',
'value' => '{{value}}'
],
'retry_delay' => {{retry_delay}},
'retry_backoff_mode' => '{{retry_backoff_mode}}',
'max_retries' => {{max_retries}},
'request_timeout_in_milliseconds' => {{request_timeout_in_milliseconds}},
'request_body_json' => [],
'headers_json' => [],
'query_params_json' => []
];
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'x-hookpulse-api-key: {{x-hookpulse-api-key}}',
'x-brand-uuid: {{x-brand-uuid}}',
'Content-Type: application/json'
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
?>
{
"success": true,
"details": "Workflow webhook added successfully"
}
Workflow Template
Add Workflow Step
Add a webhook step to an existing workflow template
POST
/
v1
/
api
/
add_workflow_step
/
curl -X POST https://api.hookpulse.io/v1/api/add_workflow_step/ \
-H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
-H "x-brand-uuid: {{x-brand-uuid}}" \
-H "Content-Type: application/json" \
-d '{
"index": {{index}},
"workflow_uuid": "{{workflow_uuid}}",
"webhook_name": "{{webhook_name}}",
"webhook_description": "{{webhook_description}}",
"method": "{{method}}",
"path": "{{path}}",
"domain_uuid": "{{domain_uuid}}",
"human_approval_required": {{human_approval_required}},
"step_identifier": "{{step_identifier}}",
"on_success_next_step_identifier": "{{on_success_next_step_identifier}}",
"on_fail_next_step_identifier": "{{on_fail_next_step_identifier}}",
"delay_to_next_step": {{delay_to_next_step}},
"execution_condition": {
"operator": "{{operator}}",
"field": "{{field}}",
"value": "{{value}}"
},
"retry_delay": {{retry_delay}},
"retry_backoff_mode": "{{retry_backoff_mode}}",
"max_retries": {{max_retries}},
"request_timeout_in_milliseconds": {{request_timeout_in_milliseconds}},
"request_body_json": {},
"headers_json": {},
"query_params_json": {}
}'
const response = await fetch('https://api.hookpulse.io/v1/api/add_workflow_step/', {
method: 'POST',
headers: {
'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
'x-brand-uuid': '{{x-brand-uuid}}',
'Content-Type': 'application/json'
},
body: JSON.stringify({
index: {{index}},
workflow_uuid: '{{workflow_uuid}}',
webhook_name: '{{webhook_name}}',
webhook_description: '{{webhook_description}}',
method: '{{method}}',
path: '{{path}}',
domain_uuid: '{{domain_uuid}}',
human_approval_required: {{human_approval_required}},
step_identifier: '{{step_identifier}}',
on_success_next_step_identifier: '{{on_success_next_step_identifier}}',
on_fail_next_step_identifier: '{{on_fail_next_step_identifier}}',
delay_to_next_step: {{delay_to_next_step}},
execution_condition: {
operator: '{{operator}}',
field: '{{field}}',
value: '{{value}}'
},
retry_delay: {{retry_delay}},
retry_backoff_mode: '{{retry_backoff_mode}}',
max_retries: {{max_retries}},
request_timeout_in_milliseconds: {{request_timeout_in_milliseconds}},
request_body_json: {},
headers_json: {},
query_params_json: {}
})
});
const data = await response.json();
console.log(data);
import requests
url = 'https://api.hookpulse.io/v1/api/add_workflow_step/'
headers = {
'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
'x-brand-uuid': '{{x-brand-uuid}}',
'Content-Type': 'application/json'
}
payload = {
'index': {{index}},
'workflow_uuid': '{{workflow_uuid}}',
'webhook_name': '{{webhook_name}}',
'webhook_description': '{{webhook_description}}',
'method': '{{method}}',
'path': '{{path}}',
'domain_uuid': '{{domain_uuid}}',
'human_approval_required': {{human_approval_required}},
'step_identifier': '{{step_identifier}}',
'on_success_next_step_identifier': '{{on_success_next_step_identifier}}',
'on_fail_next_step_identifier': '{{on_fail_next_step_identifier}}',
'delay_to_next_step': {{delay_to_next_step}},
'execution_condition': {
'operator': '{{operator}}',
'field': '{{field}}',
'value': '{{value}}'
},
'retry_delay': {{retry_delay}},
'retry_backoff_mode': '{{retry_backoff_mode}}',
'max_retries': {{max_retries}},
'request_timeout_in_milliseconds': {{request_timeout_in_milliseconds}},
'request_body_json': {},
'headers_json': {},
'query_params_json': {}
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())
require 'net/http'
require 'json'
require 'uri'
uri = URI('https://api.hookpulse.io/v1/api/add_workflow_step/')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri.path)
request['x-hookpulse-api-key'] = '{{x-hookpulse-api-key}}'
request['x-brand-uuid'] = '{{x-brand-uuid}}'
request['Content-Type'] = 'application/json'
request.body = {
index: {{index}},
workflow_uuid: '{{workflow_uuid}}',
webhook_name: '{{webhook_name}}',
webhook_description: '{{webhook_description}}',
method: '{{method}}',
path: '{{path}}',
domain_uuid: '{{domain_uuid}}',
human_approval_required: {{human_approval_required}},
step_identifier: '{{step_identifier}}',
on_success_next_step_identifier: '{{on_success_next_step_identifier}}',
on_fail_next_step_identifier: '{{on_fail_next_step_identifier}}',
delay_to_next_step: {{delay_to_next_step}},
execution_condition: {
operator: '{{operator}}',
field: '{{field}}',
value: '{{value}}'
},
retry_delay: {{retry_delay}},
retry_backoff_mode: '{{retry_backoff_mode}}',
max_retries: {{max_retries}},
request_timeout_in_milliseconds: {{request_timeout_in_milliseconds}},
request_body_json: {},
headers_json: {},
query_params_json: {}
}.to_json
response = http.request(request)
puts JSON.parse(response.body)
<?php
$url = 'https://api.hookpulse.io/v1/api/add_workflow_step/';
$data = [
'index' => {{index}},
'workflow_uuid' => '{{workflow_uuid}}',
'webhook_name' => '{{webhook_name}}',
'webhook_description' => '{{webhook_description}}',
'method' => '{{method}}',
'path' => '{{path}}',
'domain_uuid' => '{{domain_uuid}}',
'human_approval_required' => {{human_approval_required}},
'step_identifier' => '{{step_identifier}}',
'on_success_next_step_identifier' => '{{on_success_next_step_identifier}}',
'on_fail_next_step_identifier' => '{{on_fail_next_step_identifier}}',
'delay_to_next_step' => {{delay_to_next_step}},
'execution_condition' => [
'operator' => '{{operator}}',
'field' => '{{field}}',
'value' => '{{value}}'
],
'retry_delay' => {{retry_delay}},
'retry_backoff_mode' => '{{retry_backoff_mode}}',
'max_retries' => {{max_retries}},
'request_timeout_in_milliseconds' => {{request_timeout_in_milliseconds}},
'request_body_json' => [],
'headers_json' => [],
'query_params_json' => []
];
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'x-hookpulse-api-key: {{x-hookpulse-api-key}}',
'x-brand-uuid: {{x-brand-uuid}}',
'Content-Type: application/json'
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
?>
{
"success": true,
"details": "Workflow webhook added successfully"
}
Add a webhook step to an existing workflow template. This endpoint allows you to configure individual steps within a workflow, including execution order, conditions, retry logic, and template variables.
This condition ensures the step only executes if
Example:
Example:
Example:
Note: In concurrent mode, only system secret variables (
Base URL
All API requests should be made to:https://api.hookpulse.io
Example request
curl -X POST https://api.hookpulse.io/v1/api/add_workflow_step/ \
-H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
-H "x-brand-uuid: {{x-brand-uuid}}" \
-H "Content-Type: application/json" \
-d '{
"index": {{index}},
"workflow_uuid": "{{workflow_uuid}}",
"webhook_name": "{{webhook_name}}",
"webhook_description": "{{webhook_description}}",
"method": "{{method}}",
"path": "{{path}}",
"domain_uuid": "{{domain_uuid}}",
"human_approval_required": {{human_approval_required}},
"step_identifier": "{{step_identifier}}",
"on_success_next_step_identifier": "{{on_success_next_step_identifier}}",
"on_fail_next_step_identifier": "{{on_fail_next_step_identifier}}",
"delay_to_next_step": {{delay_to_next_step}},
"execution_condition": {
"operator": "{{operator}}",
"field": "{{field}}",
"value": "{{value}}"
},
"retry_delay": {{retry_delay}},
"retry_backoff_mode": "{{retry_backoff_mode}}",
"max_retries": {{max_retries}},
"request_timeout_in_milliseconds": {{request_timeout_in_milliseconds}},
"request_body_json": {},
"headers_json": {},
"query_params_json": {}
}'
const response = await fetch('https://api.hookpulse.io/v1/api/add_workflow_step/', {
method: 'POST',
headers: {
'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
'x-brand-uuid': '{{x-brand-uuid}}',
'Content-Type': 'application/json'
},
body: JSON.stringify({
index: {{index}},
workflow_uuid: '{{workflow_uuid}}',
webhook_name: '{{webhook_name}}',
webhook_description: '{{webhook_description}}',
method: '{{method}}',
path: '{{path}}',
domain_uuid: '{{domain_uuid}}',
human_approval_required: {{human_approval_required}},
step_identifier: '{{step_identifier}}',
on_success_next_step_identifier: '{{on_success_next_step_identifier}}',
on_fail_next_step_identifier: '{{on_fail_next_step_identifier}}',
delay_to_next_step: {{delay_to_next_step}},
execution_condition: {
operator: '{{operator}}',
field: '{{field}}',
value: '{{value}}'
},
retry_delay: {{retry_delay}},
retry_backoff_mode: '{{retry_backoff_mode}}',
max_retries: {{max_retries}},
request_timeout_in_milliseconds: {{request_timeout_in_milliseconds}},
request_body_json: {},
headers_json: {},
query_params_json: {}
})
});
const data = await response.json();
console.log(data);
import requests
url = 'https://api.hookpulse.io/v1/api/add_workflow_step/'
headers = {
'x-hookpulse-api-key': '{{x-hookpulse-api-key}}',
'x-brand-uuid': '{{x-brand-uuid}}',
'Content-Type': 'application/json'
}
payload = {
'index': {{index}},
'workflow_uuid': '{{workflow_uuid}}',
'webhook_name': '{{webhook_name}}',
'webhook_description': '{{webhook_description}}',
'method': '{{method}}',
'path': '{{path}}',
'domain_uuid': '{{domain_uuid}}',
'human_approval_required': {{human_approval_required}},
'step_identifier': '{{step_identifier}}',
'on_success_next_step_identifier': '{{on_success_next_step_identifier}}',
'on_fail_next_step_identifier': '{{on_fail_next_step_identifier}}',
'delay_to_next_step': {{delay_to_next_step}},
'execution_condition': {
'operator': '{{operator}}',
'field': '{{field}}',
'value': '{{value}}'
},
'retry_delay': {{retry_delay}},
'retry_backoff_mode': '{{retry_backoff_mode}}',
'max_retries': {{max_retries}},
'request_timeout_in_milliseconds': {{request_timeout_in_milliseconds}},
'request_body_json': {},
'headers_json': {},
'query_params_json': {}
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())
require 'net/http'
require 'json'
require 'uri'
uri = URI('https://api.hookpulse.io/v1/api/add_workflow_step/')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri.path)
request['x-hookpulse-api-key'] = '{{x-hookpulse-api-key}}'
request['x-brand-uuid'] = '{{x-brand-uuid}}'
request['Content-Type'] = 'application/json'
request.body = {
index: {{index}},
workflow_uuid: '{{workflow_uuid}}',
webhook_name: '{{webhook_name}}',
webhook_description: '{{webhook_description}}',
method: '{{method}}',
path: '{{path}}',
domain_uuid: '{{domain_uuid}}',
human_approval_required: {{human_approval_required}},
step_identifier: '{{step_identifier}}',
on_success_next_step_identifier: '{{on_success_next_step_identifier}}',
on_fail_next_step_identifier: '{{on_fail_next_step_identifier}}',
delay_to_next_step: {{delay_to_next_step}},
execution_condition: {
operator: '{{operator}}',
field: '{{field}}',
value: '{{value}}'
},
retry_delay: {{retry_delay}},
retry_backoff_mode: '{{retry_backoff_mode}}',
max_retries: {{max_retries}},
request_timeout_in_milliseconds: {{request_timeout_in_milliseconds}},
request_body_json: {},
headers_json: {},
query_params_json: {}
}.to_json
response = http.request(request)
puts JSON.parse(response.body)
<?php
$url = 'https://api.hookpulse.io/v1/api/add_workflow_step/';
$data = [
'index' => {{index}},
'workflow_uuid' => '{{workflow_uuid}}',
'webhook_name' => '{{webhook_name}}',
'webhook_description' => '{{webhook_description}}',
'method' => '{{method}}',
'path' => '{{path}}',
'domain_uuid' => '{{domain_uuid}}',
'human_approval_required' => {{human_approval_required}},
'step_identifier' => '{{step_identifier}}',
'on_success_next_step_identifier' => '{{on_success_next_step_identifier}}',
'on_fail_next_step_identifier' => '{{on_fail_next_step_identifier}}',
'delay_to_next_step' => {{delay_to_next_step}},
'execution_condition' => [
'operator' => '{{operator}}',
'field' => '{{field}}',
'value' => '{{value}}'
],
'retry_delay' => {{retry_delay}},
'retry_backoff_mode' => '{{retry_backoff_mode}}',
'max_retries' => {{max_retries}},
'request_timeout_in_milliseconds' => {{request_timeout_in_milliseconds}},
'request_body_json' => [],
'headers_json' => [],
'query_params_json' => []
];
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'x-hookpulse-api-key: {{x-hookpulse-api-key}}',
'x-brand-uuid: {{x-brand-uuid}}',
'Content-Type: application/json'
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
?>
Request body
| Field | Type | Required | Description |
|---|---|---|---|
index | integer | Yes | Priority index for FIFO execution order (0 is first step) |
workflow_uuid | string | Yes | UUID of the workflow template to add the step to |
webhook_name | string | Yes | Name of the webhook step |
webhook_description | string | Yes | Description of the webhook step |
method | string | Yes | HTTP method. Allowed values: "GET", "POST", "PUT", "DELETE", "PATCH" |
path | string | Yes | URL path for the webhook (supports template variables) |
domain_uuid | string | Yes | UUID of the domain associated with this webhook step |
human_approval_required | boolean | Yes | Whether this step requires human approval before execution |
step_identifier | string | Yes | Unique identifier (slug) for this step |
on_success_next_step_identifier | string | Yes | Step identifier to execute next on success |
on_fail_next_step_identifier | string | Yes | Step identifier to execute next on failure |
delay_to_next_step | integer | Yes | Delay in seconds before executing the next step |
execution_condition | object | No | Condition that must be met for this step to execute |
execution_condition.operator | string | No | Comparison operator: "eq", "ne", "lt", "gt", "lte", "gte", "in", "contains" |
execution_condition.field | string | No | Field path to evaluate |
execution_condition.value | string | No | Value to compare against |
retry_delay | integer | Yes | Delay in seconds between retry attempts (default: 10) |
retry_backoff_mode | string | Yes | Retry backoff strategy: "linear" (default) or "exponential" |
max_retries | integer | Yes | Maximum number of retry attempts (default: 5) |
request_timeout_in_milliseconds | integer | Yes | Request timeout in milliseconds (default: 5000) |
request_body_json | object | Yes | Request body as JSON object (supports template variables) |
headers_json | object | Yes | HTTP headers as JSON object (supports template variables) |
query_params_json | object | Yes | Query parameters as JSON object (supports template variables) |
Execution Order (Index)
Theindex field defines the priority and execution order for FIFO (First-In-First-Out) workflows:
- Lower index = Higher priority: Steps with lower index values execute first
- Index 0: First step to execute
- Sequential execution: In FIFO mode, steps execute in order based on their index
- Concurrent mode: Index may still be used for reference, but steps execute in parallel
Execution Conditions
Theexecution_condition field allows you to control when a step executes based on field values:
Supported Operators
| Operator | Description | Example |
|---|---|---|
eq | Equal to | amount eq 100 |
ne | Not equal to | status ne "cancelled" |
lt | Less than | quantity lt 10 |
gt | Greater than | price gt 1000 |
lte | Less than or equal to | age lte 18 |
gte | Greater than or equal to | score gte 80 |
in | Value in array | status in ["active", "pending"] |
contains | String contains substring | email contains "@example.com" |
Example Execution Condition
{
"execution_condition": {
"operator": "gt",
"field": "amount",
"value": "1000"
}
}
amount > 1000.
Template Variables
Workflow steps support dynamic variable substitution inrequest_body_json, headers_json, query_params_json, and path:
System Secret Variables
Access secrets from the System Secret Vault:{{ #key }}
{
"headers_json": {
"Authorization": "Bearer {{ #api_key }}"
}
}
Step Response Variables
Access data from previous workflow steps (FIFO mode only):{{ step.response.variable }}
{
"request_body_json": {
"payment_id": "{{ step.response.payment_id }}",
"status": "{{ step.response.status }}"
}
}
Initial Variables
Access variables from initial workflow input (FIFO mode only):{{ initial.variable }}
{
"request_body_json": {
"user_id": "{{ initial.user_id }}",
"order_total": "{{ initial.total }}"
}
}
{{ #key }}) are available. Step response and initial variables are not supported in concurrent execution.
Step Flow Control
Success and Failure Paths
on_success_next_step_identifier: Defines which step to execute next when this step succeedson_fail_next_step_identifier: Defines which step to execute next when this step failsdelay_to_next_step: Adds a delay (in seconds) before executing the next step
Human Approval
Whenhuman_approval_required is true:
- The workflow pauses at this step
- A human must approve or deny the step before execution continues
- This provides manual intervention capabilities for critical operations
Example response
{
"success": true,
"details": "Workflow webhook added successfully"
}
Response fields
| Field | Type | Description |
|---|---|---|
success | boolean | Indicates if the request was successful |
details | string | Success message |
Related Documentation
- Workflow Template Overview - Learn about workflow templates, execution modes, and features
- Add Workflow Template - Create a new workflow template
- System Secret Vault Overview - Manage secrets for use in workflow steps
Authorizations
Body
application/json
Workflow step configuration

