RUrunway
release

Get timeline events for a step config

Get timeline events for a step config in a release. Use these to see what happened and in what order — never to compute durations; timeline events are not reliable timestamps for how long anything took. For step durations and review timing, use the release step endpoints instead.

get/app/{appId}/release/{releaseId}/stepConfig/{stepConfigId}/timelineEvents

Request

  • Base URL
    https://api.runway.team
  • URL
    https://api.runway.team/app/{appId}/release/{releaseId}/stepConfig/{stepConfigId}/timelineEvents
  • Auth
    API key in header X-API-Key

Path parameters

appIdstring required

The id of the app

releaseIdstring required

The id of the release. Constructed from the app's id and the release version like so: {appId}:{version}. For the GET single release endpoint, the following keywords are also accepted: live (latest completed release), next or current (current active release).

stepConfigIdstring required

The id of the step config (FlightPaths). A step config defines a step in the release FlightPath.

Response

A list of timeline events

appIdstring required

The id of the app this event belongs to

eventDataobject nullable

The data associated with the timeline event

orgIdstring required

The id of the organization this event belongs to

releaseDataobject nullable

Release-specific data for this event

releaseIdstring nullable

The id of the release this event is associated with

status'active' | 'completed' | 'canceled' required

The status of the timeline event

triggeredAtstring date-time required

When the event was triggered

triggeredByobject nullable

Information about who or what triggered this event

typestring required

The type of timeline event

userIdstring nullable

The id of the user who triggered the event

stepArchetypesstring[]

The step archetypes associated with this event

automationDataobject nullable

Automation-specific data for this event

additionalDataobject nullable

Additional metadata associated with the event

titlestring

The title of the event

previouslySeenAtstring[]

Timestamps when this event was previously seen

workflowRunIdstring nullable

The id of the FlightPath run this event belongs to

stepRunIdstring nullable

The id of the step run this event belongs to

destinationStepConfigIdsstring[]

The destination step config ids for this event

stepConfigIdsstring[]

The step config ids that this event should be shown at

Example response

[
  {
    "triggeredAt": "2022-03-02T01:15:00Z"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.