RUrunway
approval

Create approval item

Creates a new approval item for the app. For apps using FlightPaths with multiple destinations (e.g., separate iOS and Android approval steps), include stepConfigId in the request body to specify which approvals step the item belongs to. When omitted, the first available approvals step is used, which can be ambiguous in multi-destination FlightPaths. One-off items on FlightPaths apps can be created with an initial status.

post/app/{appId}/approval

Request

  • Base URL
    https://api.runway.team
  • URL
    https://api.runway.team/app/{appId}/approval
  • Auth
    API key in header X-API-Key

Path parameters

appIdstring required

The id of the app

Request body

titlestring required

Title of the approval or regression testing item

descriptionstring

Description of the approval or regression testing item

approverGroupsUserGroup[]

The list of user groups that can approve or update this item

ownersstring[]

List of user ids allowed to approve or update item

notifyEnabledboolean

Will send a notification when item is updated.

oneOffForVersionstring

Nullable, approval or regression testing item will only appear in this version

stepConfigIdstring

Nullable - if using FlightPaths, the id of a specific approvals or regression testing step config for which to create the item

status'approved' | 'rejected' | 'inProgress' | 'blocked' | 'passed' | 'failed'

All possible statuses for a checklist item

Response

A checklist item response

idstring required

The identifier of the checklist item

titlestring required

The title of the checklist item

descriptionstring

The description of the checklist item. Accepts markdown.

approverGroupsUserGroup[] required

The list of user groups that can approve this checklist item. Custom groups can be included as well.

releaseType'all' | 'hotfixOnly' | 'rollbackOnly' | 'allExceptHotfix' required

The type of release this checklist item will appear on

notifyEnabledboolean required

Whether the checklist item will notify on Slack when its status changes

statusesChecklistItemStatusType[] required

The list of possible checklist item status types for this checklist item. A subset of all possible ChecklistItemStatusType values

releaseStepTypestring

The release step that the checklist item appears on. Will be null if the placement of the item is not binary. Can either be of type ReleaseStepType, or a step's Step ID can be sent instead

stepIdunknown
oneOffForVersionstring

If the checklist item only applies for a single release version, this field will contain the version string for that version

placement'stepChecklist' | 'approvals' | 'regressionTesting' required

The placement of a given checklist item

Example response

{
  "title": "Gather new release notes",
  "description": "Contact sully@demo.com on the copywriting team to get new release notes together.",
  "oneOffForVersion": "1.1.0",
  "status": {
    "createdAt": "2022-03-02T01:15:00Z"
  }
}

Changes

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