RUrunway
webhooks

buildDistro.buildArtifactAvailable

When the artifact of a new Build Distro build is available for download

postWebhookbuildDistro.buildArtifactAvailable

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

{
  "build": {
    "buildId": "12345",
    "bucketName": "CIs",
    "bucketId": "abc123",
    "artifactFileName": "my-app.ipa",
    "createdAt": "2022-03-02T01:15:00Z",
    "updatedAt": "2022-03-02T01:15:00Z",
    "downloadURL": "https://api.runway.team/v1/app/my-app/bucket/my-bucket/build/my-build/download",
    "ciBuildInfo": {
      "buildHash": "abc123def456",
      "buildIdentifier": "123",
      "buildUrl": "https://ci.example.com/build/123",
      "buildStartedAt": "2022-03-02T01:15:00Z",
      "buildFinishedAt": "2022-03-02T01:20:00Z",
      "providerBuildStatusString": "In progress",
      "commit": "abcdef123456",
      "commitMessage": "Fix bug in authentication",
      "commitAuthor": "John Doe",
      "commitUrl": "https://github.com/org/repo/commit/abcdef123456",
      "workflowName": "CI Build",
      "branchName": "main",
      "workflowRunIdOrCommaDelimitedIds": "workflow-run-123"
    },
    "binaryBuildNumber": "12345",
    "binaryBuildVersion": "1.2.3",
    "binaryBuildType": "ipa",
    "additionalArtifacts": [
      {
        "fileName": "test_results.html",
        "size": 1048576,
        "downloadUrl": "https://api.runway.team/v1/app/my-app/bucket/my-bucket/build/my-build/additionalFiles/test_results.html"
      }
    ]
  }
}

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.