Get a run’s status
GET
/webhooks/automation/{webhookId}/runs/{runId}Signed requestRead-only
Proven by X-ReleaseFlow-Signature-256, not by a session.
Path parameters
| Name | Type | Required | Notes |
|---|---|---|---|
webhookId | string | Required | |
runId | string (uuid) | Required |
Headers
| Name | Type | Required | Notes |
|---|---|---|---|
X-ReleaseFlow-Timestamp | string | Optional | |
X-ReleaseFlow-Delivery | string | Optional | |
X-ReleaseFlow-Signature-256 | string | Optional |
Response
Success: 200
| Field | Type | Required | Notes |
|---|---|---|---|
runId | string (uuid) | Optional | |
status | enum ExecutionStatus | Optional | PENDINGRUNNINGSUCCEEDEDFAILEDUNKNOWNCANCELLEDSKIPPED |
createdAt | string (date-time) | Optional | |
completedAt | string (date-time) | Optional | |
actions | array of ActionReceipt | Optional | |
actions[].position | integer | Optional | |
actions[].actionType | enum ActionType | Optional | GITHUB_RELEASESLACKEMAILPUBLIC_CHANGELOGNOTIONCONFLUENCEMICROSOFT_TEAMSZENDESK |
actions[].status | enum ExecutionStatus | Optional | PENDINGRUNNINGSUCCEEDEDFAILEDUNKNOWNCANCELLEDSKIPPED |
actions[].errorCode | string | Optional |
Errors
| Status | Code | Applies to |
|---|---|---|
400 | invalid_parametera path or query parameter is missing or does not convert, such as an ID that is not a UUID | Any endpoint |
404 | not_foundno such address | Any endpoint |
405 | method_not_allowedthe address does not take that method | Any endpoint |
415 | unsupported_media_typethe address does not read a body of that type | Any endpoint |
500 | internal_errora fault ReleaseFlow did not foresee; the body never carries the exception behind it | Any endpoint |
400 | webhook_payload_malformed | Webhooks area |
401 | webhook_signature_invalid | Webhooks area |
413 | webhook_payload_too_large | Webhooks area |
422 | webhook_repository_mismatch | Webhooks area |
Request
bash
# Sign the exact bytes of payload.json with the webhook secret (see the guide).
curl "http://localhost:8080/webhooks/automation/$WEBHOOK_ID/runs/$RUN_ID" \
-H "X-ReleaseFlow-Timestamp: $X_RELEASEFLOW_TIMESTAMP" \
-H "X-ReleaseFlow-Delivery: $X_RELEASEFLOW_DELIVERY" \
-H "X-ReleaseFlow-Signature-256: $X_RELEASEFLOW_SIGNATURE_256"
Response
200Example
{
"runId": "<uuid>",
"status": "PENDING",
"createdAt": "<date-time>",
"completedAt": "<date-time>",
"actions": [
{
"position": 0,
"actionType": "GITHUB_RELEASE",
"status": "PENDING",
"errorCode": "<string>"
}
]
}