Hanzo AI
OpenapiProvider

Create webhook

Receives the forge's workflow_job delivery.

POST /v1/provider/forge/webhook

Addresshttps://api.hanzo.ai/v1/provider/forge/webhook
MethodPOST
Operationpost_provider_forge_webhook
AuthAuthorization: Bearer $HANZO_API_KEY

Receives the forge's workflow_job delivery. The signature over the raw body is checked against the secret at KMS forge.WebhookRef before anything is decoded; a queued job becomes one ephemeral runner Job on the cluster, minted a registration token for exactly that job. Every other action is answered 200 and ignored.

Request

11 fields, body application/json.

FieldInTypeRequiredDescription
actionbodystring
repositorybodyobject
repository.namebodystring
repository.ownerbodyobject
repository.owner.loginbodystring
repository.owner.usernamebodystring
workflow_jobbodyobject
workflow_job.idbodyinteger
workflow_job.labelsbodystring[]
workflow_job.namebodystring
workflow_job.run_idbodyinteger

Response

StatusBodyMeaning
2XXforgeLaunchedSuccess

2XX body — 4 fields.

FieldInTypeAlwaysDescription
jobbodyinteger
orgbodystring
repobodystring
runnerbodystring

Failure carries the platform error shape — see Errors.

Examples

hanzo provider forge webhook

Provider API · All Hanzo APIs · Interactive reference

How is this guide?

On this page