Skip to main content
POST
/
v1
/
api
/
single_workflow_template_detail
curl -X POST https://api.hookpulse.io/v1/api/single_workflow_template_detail/ \
  -H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
  -H "x-brand-uuid: {{x-brand-uuid}}" \
  -H "Content-Type: application/json" \
  -d '{
    "workflow_uuid": "{{workflow_uuid}}"
  }'

{
  "data": {
    "timezone": "{{timezone}}",
    "inserted_at": "{{inserted_at}}",
    "workflow_name": "{{workflow_name}}",
    "workflow_uuid": "{{workflow_uuid}}",
    "workflow_description": "{{workflow_description}}",
    "runtype": "{{runtype}}",
    "workflow_steps": [
      {
        "index": 0,
        "timezone": "{{timezone}}",
        "inserted_at": "{{inserted_at}}",
        "step_identifier": "{{step_identifier}}",
        "human_approval_required": false,
        "delay_to_next_step": {{delay_to_next_step}},
        "webhook": {
          "path": "{{path}}",
          "domain": {
            "protocol": "{{protocol}}",
            "domain": "{{domain}}"
          },
          "method": "{{method}}",
          "webhook_uuid": "{{webhook_uuid}}",
          "webhook_name": "{{webhook_name}}",
          "headers_json": {},
          "query_params_json": {},
          "request_body_json": {},
          "expected_system_variables": []
        },
        "step_uuid": "{{step_uuid}}",
        "execution_conditions": [
          {
            "value": "{{value}}",
            "operator": "{{operator}}",
            "field": "{{field}}"
          }
        ]
      }
    ]
  },
  "success": true
}
Retrieve detailed information about a specific workflow template by its UUID, including all configured workflow steps, execution conditions, and webhook configurations.

​
Base URL

All API requests should be made to: 
https://api.hookpulse.io

​
Example request

curl -X POST https://api.hookpulse.io/v1/api/single_workflow_template_detail/ \
  -H "x-hookpulse-api-key: {{x-hookpulse-api-key}}" \
  -H "x-brand-uuid: {{x-brand-uuid}}" \
  -H "Content-Type: application/json" \
  -d '{
    "workflow_uuid": "{{workflow_uuid}}"
  }'

​
Request body

FieldTypeRequiredDescription
workflow_uuidstringYesUUID of the workflow template to retrieve

​
Example response

{
  "data": {
    "timezone": "{{timezone}}",
    "inserted_at": "{{inserted_at}}",
    "workflow_name": "{{workflow_name}}",
    "workflow_uuid": "{{workflow_uuid}}",
    "workflow_description": "{{workflow_description}}",
    "runtype": "{{runtype}}",
    "workflow_steps": [
      {
        "index": 0,
        "timezone": "{{timezone}}",
        "inserted_at": "{{inserted_at}}",
        "step_identifier": "{{step_identifier}}",
        "human_approval_required": false,
        "delay_to_next_step": {{delay_to_next_step}},
        "webhook": {
          "path": "{{path}}",
          "domain": {
            "protocol": "{{protocol}}",
            "domain": "{{domain}}"
          },
          "method": "{{method}}",
          "webhook_uuid": "{{webhook_uuid}}",
          "webhook_name": "{{webhook_name}}",
          "headers_json": {},
          "query_params_json": {},
          "request_body_json": {},
          "expected_system_variables": []
        },
        "step_uuid": "{{step_uuid}}",
        "execution_conditions": [
          {
            "value": "{{value}}",
            "operator": "{{operator}}",
            "field": "{{field}}"
          }
        ]
      }
    ]
  },
  "success": true
}

​
Response fields

​
Root fields

FieldTypeDescription
successbooleanIndicates if the request was successful
dataobjectWorkflow template details

​
Data object

FieldTypeDescription
timezonestringIANA timezone identifier indicating the timezone used for timestamps (matches your brand’s selected timezone)
inserted_atstringISO 8601 timestamp when the workflow template was created (in your brand’s selected timezone with offset)
workflow_namestringName of the workflow template
workflow_uuidstringUnique identifier for the workflow template
workflow_descriptionstringDescription of the workflow template
runtypestringExecution mode: "fifo_sequential" or "concurrently"
workflow_stepsarrayArray of workflow steps, ordered by index

​
Workflow step object

FieldTypeDescription
indexintegerPriority index for FIFO execution order (0 is first)
timezonestringIANA timezone identifier indicating the timezone used for timestamps (matches your brand’s selected timezone)
inserted_atstringISO 8601 timestamp when the workflow step was created (in your brand’s selected timezone with offset)
step_identifierstringUnique identifier (slug) for this step
human_approval_requiredbooleanWhether this step requires human approval
delay_to_next_stepintegerDelay in seconds before executing the next step
webhookobjectWebhook configuration for this step
step_uuidstringUnique identifier for the workflow step
execution_conditionsarrayArray of conditions that must be met for this step to execute

​
Execution condition object

FieldTypeDescription
valuestringValue to compare against
operatorstringComparison operator: "eq", "ne", "lt", "gt", "lte", "gte", "in", "contains"
fieldstringField path to evaluate (e.g., "amount", "step.response.payment_status", "initial.user_id")

​
Webhook object

FieldTypeDescription
pathstringURL path for the webhook (may contain template variables)
domainobjectDomain configuration
domain.protocolstringProtocol type: "http" or "https"
domain.domainstringDomain name
methodstringHTTP method: "GET", "POST", "PUT", "DELETE", or "PATCH"
webhook_namestringName of the webhook
expected_system_variablesarrayList of system variables expected in this webhook
headers_jsonobjectHTTP headers as JSON object (may contain template variables)
query_params_jsonobjectQuery parameters as JSON object (may contain template variables)
request_body_jsonobjectRequest body as JSON object (may contain template variables)
webhook_uuidstringUnique identifier for the webhook

​
Understanding the Response

​
Workflow Steps Order

Steps are returned in the order defined by their index field:
  • Index 0: First step to execute
  • Index 1: Second step to execute
  • And so on…
In FIFO mode, steps execute sequentially based on their index. In concurrent mode, steps may execute in parallel.

​
Execution Conditions

Each step can have multiple execution conditions. All conditions must evaluate to true for the step to execute:
  • Empty array: Step always executes (no conditions)
  • Multiple conditions: All must be met (AND logic)

​
Template Variables

The response shows template variables used in webhook configurations:
  • {{ #key }}: System secret from vault
  • {{ step.response.key }}: Variable from previous step response
  • {{ initial.key }}: Variable from initial workflow input

​
Human Approval

When human_approval_required is true, the workflow pauses at that step and waits for manual approval before continuing.

Authorizations

​
x-hookpulse-api-key
string
header
required

API key for authentication. Get this from your dashboard by selecting a brand and going to API Keys section.

​
x-brand-uuid
string
header
required

Brand UUID for authentication. Get this from your dashboard after adding a brand - it will be displayed in the UI.

Body

application/json

Workflow template UUID

​
workflow_uuid
string
required

UUID of the workflow template

Response

Successful response

​
data
object
​
success
boolean

Indicates if the request was successful