Documentation Index
Fetch the complete documentation index at: https://mintlify.com/tailor-platform/sdk/llms.txt
Use this file to discover all available pages before exploring further.
Commands for managing executors and executor jobs.
executor
Manage executors
Usage
tailor-sdk executor [command]
| Command | Description |
|---|
executor list | List all executors |
executor get | Get executor details |
executor jobs | List or get executor jobs |
executor trigger | Trigger an executor manually |
executor webhook | Manage executor webhooks |
executor list
List all executors in the workspace.
Usage
tailor-sdk executor list [options]
| Option | Alias | Description | Required | Default |
|---|
--json | -j | Output as JSON | No | false |
--workspace-id <WORKSPACE_ID> | -w | Workspace ID | No | - |
--profile <PROFILE> | -p | Workspace profile | No | - |
executor get
Get executor details by name.
Usage
tailor-sdk executor get [options] <name>
| Argument | Description | Required |
|---|
name | Executor name | Yes |
| Option | Alias | Description | Required | Default |
|---|
--json | -j | Output as JSON | No | false |
--workspace-id <WORKSPACE_ID> | -w | Workspace ID | No | - |
--profile <PROFILE> | -p | Workspace profile | No | - |
executor jobs
List or get executor jobs.
Usage
tailor-sdk executor jobs [options] <executorName> [jobId]
| Argument | Description | Required |
|---|
executorName | Executor name | Yes |
jobId | Job ID (if provided, shows job details) | No |
| Option | Alias | Description | Required | Default |
|---|
--json | -j | Output as JSON | No | false |
--workspace-id <WORKSPACE_ID> | -w | Workspace ID | No | - |
--profile <PROFILE> | -p | Workspace profile | No | - |
--status <STATUS> | -s | Filter by status (PENDING, RUNNING, SUCCESS, FAILED, CANCELED) (list mode only) | No | - |
--attempts | - | Show job attempts (only with job ID) (detail mode only) | No | false |
--wait | -W | Wait for job completion and downstream execution (workflow/function) if applicable (detail mode only) | No | false |
--interval <INTERVAL> | -i | Polling interval when using —wait (e.g., ‘3s’, ‘500ms’, ‘1m’) | No | "3s" |
--logs | -l | Display function execution logs after completion (requires —wait) | No | false |
--limit <LIMIT> | - | Maximum number of jobs to list (default: 50, max: 1000) (list mode only) | No | - |
tailor-sdk executor jobs my-executor
tailor-sdk executor jobs my-executor --limit 10
tailor-sdk executor jobs my-executor -s RUNNING
tailor-sdk executor jobs my-executor <job-id>
tailor-sdk executor jobs my-executor <job-id> --attempts
tailor-sdk executor jobs my-executor <job-id> -W
tailor-sdk executor jobs my-executor <job-id> -W -l
executor trigger
Trigger an executor manually.
Usage
tailor-sdk executor trigger [options] <executorName>
| Argument | Description | Required |
|---|
executorName | Executor name | Yes |
| Option | Alias | Description | Required | Default |
|---|
--json | -j | Output as JSON | No | false |
--workspace-id <WORKSPACE_ID> | -w | Workspace ID | No | - |
--profile <PROFILE> | -p | Workspace profile | No | - |
--data <DATA> | -d | Request body (JSON string) | No | - |
--header <HEADER> | -H | Request header (format: ‘Key: Value’, can be specified multiple times) | No | - |
--wait | -W | Wait for job completion and downstream execution (workflow/function) if applicable | No | false |
--interval <INTERVAL> | -i | Polling interval when using —wait (e.g., ‘3s’, ‘500ms’, ‘1m’) | No | "3s" |
--logs | -l | Display function execution logs after completion (requires —wait) | No | false |
tailor-sdk executor trigger my-executor
tailor-sdk executor trigger my-executor -d '{"message": "hello"}'
tailor-sdk executor trigger my-executor -d '{"message": "hello"}' -H "X-Custom: value" -H "X-Another: value2"
tailor-sdk executor trigger my-executor -W
tailor-sdk executor trigger my-executor -W -l
Important NotesOnly executors with INCOMING_WEBHOOK or SCHEDULE trigger types can be triggered manually.
Executors with EVENT trigger types (such as recordCreated, recordUpdated, recordDeleted) cannot be triggered manually.The --data and --header options are only available for INCOMING_WEBHOOK trigger type.
--wait, the CLI tracks not only the executor job but also any downstream executions:
- Workflow targets: Waits for the workflow execution to complete (SUCCESS, FAILED, or PENDING_RESUME). Shows real-time status changes and currently running job names during execution (same output as
workflow start --wait).
- Function targets: Waits for the function execution to complete
- Webhook/GraphQL targets: Only waits for the executor job itself
The --logs option displays logs from the downstream execution when available.
executor webhook
Manage executor webhooks.
Usage
tailor-sdk executor webhook [command]
| Command | Description |
|---|
executor webhook list | List executors with incoming webhook triggers |
executor webhook list
List executors with incoming webhook triggers.
Usage
tailor-sdk executor webhook list [options]
| Option | Alias | Description | Required | Default |
|---|
--json | -j | Output as JSON | No | false |
--workspace-id <WORKSPACE_ID> | -w | Workspace ID | No | - |
--profile <PROFILE> | -p | Workspace profile | No | - |