Shipfox events

See which Shipfox run and job events can start a workflow, when each one fires, and what it contains.

Filter out your own runs

Shipfox doesn't stop a workflow from triggering itself. Filter on event.project.name and event.run.origin, and exclude the workflow's own path. See Avoid trigger loops.

Reruns and dev runs send these events too. Filter on event.run.attempt == 1 to skip reruns, or on event.run.origin == 'synced' to skip dev runs.

When events fire

Each run attempt sends its own run.requested and run.completed events. It sends run.started only if it starts running, so an attempt cancelled while it waits skips it. A job that a rerun keeps from the previous attempt sends no job events in the new attempt.

A job sends job.queued when an execution is queued, job.started when a runner claims that execution, and job.completed once. An execution cancelled before a runner claims it sends no job.started. A one-shot job has one execution. A listening job starts one execution for each matching event or event batch, so it sends job.queued and job.started many times in one run. Read event.job.execution.sequence to tell its executions apart. The listening job sends job.completed once, when it resolves.

A skipped job sends only job.completed, with event.job.status set to skipped.

Settings → Events lists a Shipfox event only when a workflow was listening for it. Runs that ended before you added the trigger have no event to inspect or replay.

Event catalog

The shipfox integration is available without any setup.

Events: 6in 6 groups
Learn more: Fields appear below.

Run requested

1 event

A workflow run attempt was requested.

Events

Payload

projectobjectRequired

Project that owns the run.

Show 2 attributes

idstring (uuid)Required

namestringRequired

Project name when Shipfox delivers the event.

workflowobjectRequired

Workflow that the run executes.

Show 3 attributes

idstring (uuid)Required

Workflow definition ID.

namestringRequired

pathstring | nullRequired

Workflow file path in the repository, for example `.shipfox/workflows/build.yml`.

runobjectRequired

Run that the event is about.

Show 12 attributes

idstring (uuid)Required

numberintegerRequired

Run number within the workflow.

attemptintegerRequired

Run attempt. A rerun increments it.

namestringRequired

originstringRequired

`synced` for a run of a synced workflow definition, `dev` for a dev run.

Possible values: synced, dev

triggerobjectRequired

Trigger that started the run.

Show 2 attributes

sourcestringRequired

Trigger `source` that started the run.

eventstringRequired

Event name that started the run.

refstring | nullRequired

Git ref of the run, when known.

commitstring | nullRequired

Git commit SHA of the run, when known.

parent_run_idstring (uuid) | nullRequired

ID of the run that started this run with `start_workflow_run`.

root_run_idstring (uuid) | nullRequired

ID of the first run in a chain of runs started with `start_workflow_run`.

created_atstring (date-time)Required

Time the run was created.

statusstringRequired

`waiting` when the run waits for its concurrency group, otherwise `pending`.

Possible values: pending, waiting

Run started

1 event

A workflow run attempt started running.

Events

Payload

projectobjectRequired

Project that owns the run.

Show 2 attributes

idstring (uuid)Required

namestringRequired

Project name when Shipfox delivers the event.

workflowobjectRequired

Workflow that the run executes.

Show 3 attributes

idstring (uuid)Required

Workflow definition ID.

namestringRequired

pathstring | nullRequired

Workflow file path in the repository, for example `.shipfox/workflows/build.yml`.

runobjectRequired

Run that the event is about.

Show 13 attributes

idstring (uuid)Required

numberintegerRequired

Run number within the workflow.

attemptintegerRequired

Run attempt. A rerun increments it.

namestringRequired

originstringRequired

`synced` for a run of a synced workflow definition, `dev` for a dev run.

Possible values: synced, dev

triggerobjectRequired

Trigger that started the run.

Show 2 attributes

sourcestringRequired

Trigger `source` that started the run.

eventstringRequired

Event name that started the run.

refstring | nullRequired

Git ref of the run, when known.

commitstring | nullRequired

Git commit SHA of the run, when known.

parent_run_idstring (uuid) | nullRequired

ID of the run that started this run with `start_workflow_run`.

root_run_idstring (uuid) | nullRequired

ID of the first run in a chain of runs started with `start_workflow_run`.

created_atstring (date-time)Required

Time the run was created.

statusconstant "running"Required

started_atstring (date-time)Required

Time the run attempt started running.

Run completed

1 event

A workflow run attempt completed.

Events

Payload

projectobjectRequired

Project that owns the run.

Show 2 attributes

idstring (uuid)Required

namestringRequired

Project name when Shipfox delivers the event.

workflowobjectRequired

Workflow that the run executes.

Show 3 attributes

idstring (uuid)Required

Workflow definition ID.

namestringRequired

pathstring | nullRequired

Workflow file path in the repository, for example `.shipfox/workflows/build.yml`.

runobjectRequired

Run that the event is about.

Show 16 attributes

idstring (uuid)Required

numberintegerRequired

Run number within the workflow.

attemptintegerRequired

Run attempt. A rerun increments it.

namestringRequired

originstringRequired

`synced` for a run of a synced workflow definition, `dev` for a dev run.

Possible values: synced, dev

triggerobjectRequired

Trigger that started the run.

Show 2 attributes

sourcestringRequired

Trigger `source` that started the run.

eventstringRequired

Event name that started the run.

refstring | nullRequired

Git ref of the run, when known.

commitstring | nullRequired

Git commit SHA of the run, when known.

parent_run_idstring (uuid) | nullRequired

ID of the run that started this run with `start_workflow_run`.

root_run_idstring (uuid) | nullRequired

ID of the first run in a chain of runs started with `start_workflow_run`.

created_atstring (date-time)Required

Time the run was created.

statusstringRequired

Final status of the run attempt.

Possible values: succeeded, failed, cancelled

status_reasonstring | nullRequired

Why the run attempt failed or was cancelled, when known.

Possible values: job_failed, timed_out, user_cancelled, concurrency_superseded, output_invalid, output_too_large

started_atstring (date-time) | nullRequired

Time the run attempt started running. `null` when it never started.

finished_atstring (date-time)Required

Time the run attempt finished.

outputsobject | nullRequired

Workflow `outputs` of a succeeded run. `null` for other statuses.

Job queued

1 event

A job execution was queued for a runner.

Events

Payload

projectobjectRequired

Project that owns the run.

Show 2 attributes

idstring (uuid)Required

namestringRequired

Project name when Shipfox delivers the event.

workflowobjectRequired

Workflow that the run executes.

Show 3 attributes

idstring (uuid)Required

Workflow definition ID.

namestringRequired

pathstring | nullRequired

Workflow file path in the repository, for example `.shipfox/workflows/build.yml`.

runobjectRequired

Run that the event is about.

Show 11 attributes

idstring (uuid)Required

numberintegerRequired

Run number within the workflow.

attemptintegerRequired

Run attempt. A rerun increments it.

namestringRequired

originstringRequired

`synced` for a run of a synced workflow definition, `dev` for a dev run.

Possible values: synced, dev

triggerobjectRequired

Trigger that started the run.

Show 2 attributes

sourcestringRequired

Trigger `source` that started the run.

eventstringRequired

Event name that started the run.

refstring | nullRequired

Git ref of the run, when known.

commitstring | nullRequired

Git commit SHA of the run, when known.

parent_run_idstring (uuid) | nullRequired

ID of the run that started this run with `start_workflow_run`.

root_run_idstring (uuid) | nullRequired

ID of the first run in a chain of runs started with `start_workflow_run`.

created_atstring (date-time)Required

Time the run was created.

jobobjectRequired

Job that the event is about.

Show 6 attributes

idstring (uuid)Required

keystringRequired

Job key in the workflow `jobs` map.

modestringRequired

`listening` for a listening job, otherwise `one_shot`.

Possible values: one_shot, listening

executionobjectRequired

Job execution the event is about.

Show 2 attributes

idstring (uuid)Required

sequenceintegerRequired

Execution number within the job. A listening job has one per event batch.

statusconstant "pending"Required

queued_atstring (date-time)Required

Time the execution was queued.

Job started

1 event

A runner claimed a job execution.

Events

Payload

projectobjectRequired

Project that owns the run.

Show 2 attributes

idstring (uuid)Required

namestringRequired

Project name when Shipfox delivers the event.

workflowobjectRequired

Workflow that the run executes.

Show 3 attributes

idstring (uuid)Required

Workflow definition ID.

namestringRequired

pathstring | nullRequired

Workflow file path in the repository, for example `.shipfox/workflows/build.yml`.

runobjectRequired

Run that the event is about.

Show 11 attributes

idstring (uuid)Required

numberintegerRequired

Run number within the workflow.

attemptintegerRequired

Run attempt. A rerun increments it.

namestringRequired

originstringRequired

`synced` for a run of a synced workflow definition, `dev` for a dev run.

Possible values: synced, dev

triggerobjectRequired

Trigger that started the run.

Show 2 attributes

sourcestringRequired

Trigger `source` that started the run.

eventstringRequired

Event name that started the run.

refstring | nullRequired

Git ref of the run, when known.

commitstring | nullRequired

Git commit SHA of the run, when known.

parent_run_idstring (uuid) | nullRequired

ID of the run that started this run with `start_workflow_run`.

root_run_idstring (uuid) | nullRequired

ID of the first run in a chain of runs started with `start_workflow_run`.

created_atstring (date-time)Required

Time the run was created.

jobobjectRequired

Job that the event is about.

Show 7 attributes

idstring (uuid)Required

keystringRequired

Job key in the workflow `jobs` map.

modestringRequired

`listening` for a listening job, otherwise `one_shot`.

Possible values: one_shot, listening

executionobjectRequired

Job execution the event is about.

Show 2 attributes

idstring (uuid)Required

sequenceintegerRequired

Execution number within the job. A listening job has one per event batch.

statusconstant "running"Required

runner_labelsarray of string | nullRequired

Labels of the runner that claimed the execution, when known.

Minimum 1 item.

started_atstring (date-time)Required

Time a runner claimed the execution.

Job completed

1 event

A job completed or was skipped.

Events

Payload

projectobjectRequired

Project that owns the run.

Show 2 attributes

idstring (uuid)Required

namestringRequired

Project name when Shipfox delivers the event.

workflowobjectRequired

Workflow that the run executes.

Show 3 attributes

idstring (uuid)Required

Workflow definition ID.

namestringRequired

pathstring | nullRequired

Workflow file path in the repository, for example `.shipfox/workflows/build.yml`.

runobjectRequired

Run that the event is about.

Show 11 attributes

idstring (uuid)Required

numberintegerRequired

Run number within the workflow.

attemptintegerRequired

Run attempt. A rerun increments it.

namestringRequired

originstringRequired

`synced` for a run of a synced workflow definition, `dev` for a dev run.

Possible values: synced, dev

triggerobjectRequired

Trigger that started the run.

Show 2 attributes

sourcestringRequired

Trigger `source` that started the run.

eventstringRequired

Event name that started the run.

refstring | nullRequired

Git ref of the run, when known.

commitstring | nullRequired

Git commit SHA of the run, when known.

parent_run_idstring (uuid) | nullRequired

ID of the run that started this run with `start_workflow_run`.

root_run_idstring (uuid) | nullRequired

ID of the first run in a chain of runs started with `start_workflow_run`.

created_atstring (date-time)Required

Time the run was created.

jobobjectRequired

Job that the event is about.

Show 7 attributes

idstring (uuid)Required

keystringRequired

Job key in the workflow `jobs` map.

modestringRequired

`listening` for a listening job, otherwise `one_shot`.

Possible values: one_shot, listening

statusstringRequired

Final status of the job.

Possible values: succeeded, failed, cancelled, skipped

status_reasonstring | nullRequired

Why the job failed, was cancelled, or was skipped, when known.

Possible values: dependency_not_completed, condition_false, default_gate_rejected, condition_rejected, condition_errored, user_cancelled, run_cancelled, concurrency_superseded, timed_out, lease_expired, provider_lost, lifecycle_violation, runner_lost, output_too_large, step_failed, unknown, output_invalid, runner_not_allowed

finished_atstring (date-time)Required

Time the job finished.

outputsobject | nullRequired

Job `outputs` of a succeeded job. `null` for other statuses.

Was this page helpful?

Edit this page on GitHub

When events fire

Event catalog

Events

Payload

Events

Payload

Events

Payload

Events

Payload

Events

Payload

Events

Payload

On this page