Skip to main content

Trigger automation webhook

POST/webhooks/automation/{webhookId}
Signed request

Proven by X-ReleaseFlow-Signature-256, not by a session.

Read the guideSource: AutomationWebhookController#trigger(opens in new tab)

Path parameters​

NameTypeRequiredNotes
webhookIdstringRequired

Headers​

NameTypeRequiredNotes
X-ReleaseFlow-TimestampstringOptional
X-ReleaseFlow-DeliverystringOptional
X-ReleaseFlow-Signature-256stringOptional

Request body​

application/json · The body is optional.

The provider’s JSON payload, exactly as it was signed.

Response​

Success: 202

FieldTypeRequiredNotes
runIdstring (uuid)Optional
statusenum ExecutionStatusOptionalPENDINGRUNNINGSUCCEEDEDFAILEDUNKNOWNCANCELLEDSKIPPED
statusPathstringOptional

Errors​

StatusCodeApplies to
400invalid_parametera path or query parameter is missing or does not convert, such as an ID that is not a UUIDAny endpoint
404not_foundno such addressAny endpoint
405method_not_allowedthe address does not take that methodAny endpoint
415unsupported_media_typethe address does not read a body of that typeAny endpoint
500internal_errora fault ReleaseFlow did not foresee; the body never carries the exception behind itAny endpoint
400webhook_payload_malformedWebhooks area
401webhook_signature_invalidWebhooks area
413webhook_payload_too_largeWebhooks area
422webhook_repository_mismatchWebhooks 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

202

Example

{
  "runId": "<uuid>",
  "status": "PENDING",
  "statusPath": "<string>"
}