Skip to content

List workflows ​


Use this endpoint to list all workflow configurations created for your Truto environment. Workflows are returned based on the current authenticated environment.

Endpoint ​

http
GET /workflow

Query parameters ​

Refer Specifying query parameters in Truto APIs

trigger_name
string

Filter workflows by trigger name.

Example: integrated_account:active
environment_id
string · uuid

Filter workflows by environment ID.

Example: 1ba1f401-7183-47c5-9e39-e8e257e3c795

Response Body ​

results
object[]
id
string · uuid
Example: 4a4de828-f4db-4c9e-adfd-434e0864c3c7
environment_id
string · uuid
Example: 05daecaf-4365-42e8-8370-8127de5dd717
trigger_name
string
Example: integrated_account:connected
config
object
REQUIRED · 

Workflow execution configuration.

run_if
string

JSONata condition evaluated before executing workflow steps.

Example: integration.name = 'calcom'
steps
object[]
type
string

Step execution type.

All possible enum values:
  • run
Example: run
action
string

Action executed by the step.

Example: run_sync_job
cron_expression
string

Optional cron expression for scheduled execution.

Example: 0 */6 * * *
config
string

JSONata expression evaluated at runtime to generate the step execution payload.

Example: ( $sync_job_id := $mapValues(integration.name,{ "calcom": "51b79ace-a7b4-4077-93ba-8048a06ece2b" }); { "sync_job_id": $sync_job_id, "integrated_account_id": integrated_account_id, "webhook_id": "9fda519d-148f-4cc5-bbac-4e373b16e5d4" } )
created_at
string · date-time
updated_at
string · date-time
next_cursor
string
limit
number