REST API
Endpoints
- public
- workspaces
- workflows
- triggers
- workflow-executions
- actions
- secrets
- schedules
- tags
- users
- organization
- editor
- registry-repositories
- registry-actions
- settings
- organization-secrets
- tables
- auth
Get Workflow
Return Workflow as title, description, list of Action JSONs, adjacency list of Action IDs.
{
"id": "<string>",
"title": "<string>",
"description": "<string>",
"status": "<string>",
"actions": {},
"object": {},
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"webhook": {
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "<string>",
"secret": "<string>",
"status": "online",
"entrypoint_ref": "<string>",
"filters": {},
"method": "GET",
"workflow_id": "<string>",
"url": "<string>"
},
"schedules": [
{
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "<string>",
"status": "online",
"cron": "<string>",
"inputs": {},
"every": "<string>",
"offset": "<string>",
"start_at": "2023-11-07T05:31:56Z",
"end_at": "2023-11-07T05:31:56Z",
"timeout": 123,
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"entrypoint": "<string>",
"static_inputs": {},
"expects": {},
"returns": "<any>",
"config": {
"environment": "default",
"timeout": 300
},
"alias": "<string>",
"error_handler": "<string>"
}
Authorizations
Path Parameters
Query Parameters
Response
1000
1000
any
, all
Total number of execution attempts. 0 means unlimited, 1 means no retries.
Timeout for the action in seconds.
Retry until a specific condition is met.
Delay before starting the action in seconds. If wait_until
is also provided, the wait_until
timer will take precedence.
Wait until a specific date and time before starting. Overrides start_delay
if both are provided.
online
, offline
GET
, POST
ISO 8601 duration string
ISO 8601 duration string
ISO 8601 datetime string
ISO 8601 datetime string
The maximum number of seconds to wait for the workflow to complete
This is the runtime configuration for the workflow.
Activities don't need access to this.
The workflow's target execution environment. This is used to isolate secrets across different environments.If not provided, the default environment (default) is used.
The maximum number of seconds to wait for the workflow to complete.
Was this page helpful?
{
"id": "<string>",
"title": "<string>",
"description": "<string>",
"status": "<string>",
"actions": {},
"object": {},
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"webhook": {
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "<string>",
"secret": "<string>",
"status": "online",
"entrypoint_ref": "<string>",
"filters": {},
"method": "GET",
"workflow_id": "<string>",
"url": "<string>"
},
"schedules": [
{
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "<string>",
"status": "online",
"cron": "<string>",
"inputs": {},
"every": "<string>",
"offset": "<string>",
"start_at": "2023-11-07T05:31:56Z",
"end_at": "2023-11-07T05:31:56Z",
"timeout": 123,
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"entrypoint": "<string>",
"static_inputs": {},
"expects": {},
"returns": "<any>",
"config": {
"environment": "default",
"timeout": 300
},
"alias": "<string>",
"error_handler": "<string>"
}