Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Signal a run
Sends a named signal to a running Run; a `wait` op for that name resumes with its payload.
Sends a named signal to a running Run; a wait op for that name resumes with its payload. A signal to a closed Run fails with INVALID_STATE.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow/runs/run:signal - Scope
workflows:run - Effect
write— a successful call changes state. - Collection runs
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the run. Required. |
signal | string | The signal name the handler waits on. Required. |
payload | struct | The signal payload, at most 64 KiB of JSON. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/workflows/{workflow}/runs/{run}. |
uid | string | run_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
workflow_generation | int64 | The Workflow generation the Run pinned at start. Output only. |
input | struct | The Run input, at most 256 KiB of JSON. |
start_delay | duration | Delay the first invocation by this much. |
state | RunState | The Run's lifecycle state. Output only. One of running, succeeded, failed, cancelled, timed_out. |
schedule_fire | ScheduleFireRef | Set when a Schedule fire started the Run. Output only. |
batch_position | BatchPosition | Set on a child of a batch Run. Output only. |
start_time | timestamp | When the Run started. Output only. |
end_time | timestamp | When the Run closed. Output only. |
attempt_count | int32 | Attempts made so far, across every step. Output only. |
output | struct | The handler's complete output, once succeeded. Output only. |
error | RunError | The failure, once failed or timed_out. Output only. |
schedule_time | timestamp | When the first invocation is due: set it directly, or through start_delay; at most 365 days ahead. A Run cancelled before then closes cancelled with no invocation. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#ScheduleFireRef
| Field | Type | What it is |
|---|---|---|
schedule | string | The Schedule. Output only. |
intended_time | timestamp | The instant the fire was due. Output only. |
#BatchPosition
| Field | Type | What it is |
|---|---|---|
parent_run | string | The parent batch Run. Output only. |
index | int32 | Zero-based index of this child. Output only. |
total_count | int32 | Number of children in the batch. Output only. |
#RunError
| Field | Type | What it is |
|---|---|---|
code | string | A machine-readable code, for example handler_rejected or card_declined. Output only. |
message | string | A customer-safe message. Output only. |
retryable | bool | Whether the handler marked the failure retryable. Output only. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.INVALID_FIELD— A field failed validation.INVALID_STATE— The Resource is in a state that forbids the call.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.
Every error arrives in the body Errors describes.
#Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow/runs/run:signal" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"signal":"…"}'