RUrunway
webhooks

checklistItem.statusChanged

When the status of a checklist item, regression testing item, or approval item has changed. All platforms.

postWebhookchecklistItem.statusChanged

Payload

eventTypestring required

The type of event that was sent

wasAutomatedByRunwayboolean required

True if the event happened as a result of an action automated by Runway

Example payload

{
  "app": {
    "id": "fake-app",
    "appName": "Fake app",
    "createdAt": "2022-03-02T01:15:00Z"
  },
  "release": {
    "id": "fake-app:1.0.0",
    "version": "1.0.0",
    "createdAt": "2022-03-02T01:15:00Z",
    "releasePilotId": "sully@example.com",
    "targetKickoffDate": "2022-03-02T01:15:00Z",
    "targetSubmissionDate": "2022-03-02T01:15:00Z",
    "targetReleaseDate": "2022-03-02T01:15:00Z",
    "releaseBranch": "release-1.0.0",
    "updatedAt": "2022-03-02T01:15:00Z",
    "kickedOffAt": "2022-03-02T01:15:00Z",
    "submittedAt": "2022-03-02T01:15:00Z",
    "releasedAt": "2022-03-02T01:15:00Z",
    "rolloutCompletedAt": "2022-03-02T01:15:00Z",
    "completedAt": "2022-03-02T01:15:00Z",
    "regressionTestingStatus": {
      "updatedAt": "2022-03-02T01:15:00Z"
    },
    "workItems": [
      {
        "id": "acb-1234",
        "ticket": {
          "createdAt": "2022-03-02T01:15:00Z",
          "updatedAt": "2022-03-02T01:15:00Z"
        },
        "code": {
          "committedAt": "2022-03-02T01:15:00Z",
          "authoredAt": "2022-03-02T01:15:00Z"
        }
      }
    ],
    "steps": [
      {
        "data": {
          "approvalItems": [
            {
              "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"
              }
            }
          ]
        },
        "checklistItems": [
          {
            "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"
            }
          }
        ]
      }
    ],
    "customMetadata": {
      "incident-4821": {
        "title": "Incident link",
        "value": "https://incidents.example.com/4821"
      }
    }
  },
  "checklistItem": {
    "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"
    }
  }
}

Response

Return a 200 status to indicate that the data was received successfully

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.