CoderHelm Docs
APIWebhook endpoints

Create a webhook endpoint

POST
/api/webhooks/endpoints

Adds an endpoint and makes its signing secret, which this answer shows once. The address must be https:// and on the public internet: private, local and cloud metadata addresses are refused here and again before every delivery. A team has at most 20 endpoints.

Authorization

api_key webhooks
headerAuthorizationBearer <token>

A team API key, made by an admin under Settings, API keys. Send it as Authorization: Bearer chk_....

Scope: webhooks

Request Body

application/json
  1. body

A new endpoint.

description?|

A note for people: what the endpoint is for.

Example"Deploy bot"
enabled?|

Defaults to true.

Exampletrue
events?array<string>|

Event types to receive, or ["*"] for every event. Defaults to every event.

Example
[  "run.completed",  "run.failed"]
url*string

An https:// address on the public internet.

Example"https://hooks.example.com/coderhelm"

Response Body

Created. Keep the secret.

application/json
  1. response

A new endpoint and its signing secret. The secret is shown here once; reveal it later with GET …/secret.

endpoint*

A webhook endpoint. Never carries its secret.

secret*string

whsec_ and 32 random bytes in base64. Verify signatures with it.

Example"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD7vS8nSUIQ2c="
curl -X POST 'https://api.coderhelm.com/api/webhooks/endpoints' \  -H "Authorization: Bearer $CODERHELM_API_KEY" \  -H 'Content-Type: application/json' \  -d '{  "url": "https://hooks.example.com/coderhelm"}'
{  "endpoint": {    "created_at": "2026-10-20T09:00:00Z",    "created_by": "lead@example.com",    "description": "Deploy bot",    "disabled_reason": "",    "enabled": true,    "events": [      "run.completed",      "run.failed"    ],    "failing_since": null,    "id": "ep_01jbendpt4a7b0c3d6e9f2g5h8",    "last_failure_at": "2026-10-25T08:02:11.004Z",    "last_success_at": "2026-10-26T14:31:48.120Z",    "previous_secret_expires_at": "2026-10-27T09:00:00Z",    "secret_hint": "whsec_…Q2c=",    "updated_at": "2026-10-20T09:00:00Z",    "url": "https://hooks.example.com/coderhelm"  },  "secret": "whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD7vS8nSUIQ2c="}
Edit on GitHub