Create webhook
Receives the forge's workflow_job delivery.
POST /v1/provider/forge/webhook
| Address | https://api.hanzo.ai/v1/provider/forge/webhook |
| Method | POST |
| Operation | post_provider_forge_webhook |
| Auth | Authorization: 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.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
action | body | string | — | |
repository | body | object | — | |
repository.name | body | string | — | |
repository.owner | body | object | — | |
repository.owner.login | body | string | — | |
repository.owner.username | body | string | — | |
workflow_job | body | object | — | |
workflow_job.id | body | integer | — | |
workflow_job.labels | body | string[] | — | |
workflow_job.name | body | string | — | |
workflow_job.run_id | body | integer | — |
Response
| Status | Body | Meaning |
|---|---|---|
2XX | forgeLaunched | Success |
2XX body — 4 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
job | body | integer | — | |
org | body | string | — | |
repo | body | string | — | |
runner | body | string | — |
Failure carries the platform error shape — see Errors.
Examples
hanzo provider forge webhookimport { Configuration, ProviderApi } from 'hanzoai';
const api = new ProviderApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postProviderForgeWebhook({ action: "<action>", repository: {"name":"<name>","owner":{"login":"<login>","username":"<username>"}} });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import ProviderApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = ProviderApi(client).post_provider_forge_webhook(action="<action>", repository={"name":"<name>","owner":{"login":"<login>","username":"<username>"}})cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.ProviderAPI.PostProviderForgeWebhook(context.Background()).Execute()
if err != nil {
return err
}use hanzo_client::apis::{configuration::Configuration, provider_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = provider_api::post_provider_forge_webhook(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.ProviderApi;
ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));
var result = new ProviderApi(client).postProviderForgeWebhook();The method above is the one at the current release of the document. [email protected] (npm) was generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl -X POST https://api.hanzo.ai/v1/provider/forge/webhook \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"action": "<action>",
"repository": {
"name": "<name>",
"owner": {
"login": "<login>",
"username": "<username>"
}
}
}'MCP declares no tool for provider — tools/list on https://api.hanzo.ai/v1/mcp names the products it does reach. Use HTTP or an SDK.
How is this guide?