Trigger automation webhook
POST
/webhooks/automation/{webhookId}Signed request
Proven by X-ReleaseFlow-Signature-256, not by a session.
Path parameters
| Name | Type | Required | Notes |
|---|---|---|---|
webhookId | string | Required |
Headers
| Name | Type | Required | Notes |
|---|---|---|---|
X-ReleaseFlow-Timestamp | string | Optional | |
X-ReleaseFlow-Delivery | string | Optional | |
X-ReleaseFlow-Signature-256 | string | Optional |
Request body
application/json · The body is optional.
The provider’s JSON payload, exactly as it was signed.
Response
Success: 202
| Field | Type | Required | Notes |
|---|---|---|---|
runId | string (uuid) | Optional | |
status | enum ExecutionStatus | Optional | PENDINGRUNNINGSUCCEEDEDFAILEDUNKNOWNCANCELLEDSKIPPED |
statusPath | 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 -X POST "http://localhost:8080/webhooks/automation/$WEBHOOK_ID" \
-H "X-ReleaseFlow-Timestamp: $X_RELEASEFLOW_TIMESTAMP" \
-H "X-ReleaseFlow-Delivery: $X_RELEASEFLOW_DELIVERY" \
-H "X-ReleaseFlow-Signature-256: $X_RELEASEFLOW_SIGNATURE_256" \
-H "Content-Type: application/json" \
--data-binary @payload.json
Response
202Example
{
"runId": "<uuid>",
"status": "PENDING",
"statusPath": "<string>"
}