Skip to main content
POST
Create

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

orgId
string
required

The organization's id (UUID) or slug — either form is accepted.

Body

application/json
url
string
required

HTTPS endpoint to deliver events to, e.g. "https://hooks.acme.com/korve". Plain http is refused.

events
enum<string>[]
required

Event types to deliver. At least one; duplicates are ignored.

Platform event type: deploy.failed (a deployment failed), budget.alert (a project passed its budget alert threshold), budget.exceeded (a project reached its monthly budget cap).

Available options:
deploy.failed,
budget.alert,
budget.exceeded

Response

Webhook registered. secret is the signing secret — shown exactly once; store it securely.

id
string
required
url
string
required

HTTPS endpoint events are POSTed to. Unique per organization.

events
enum<string>[]
required

Event types delivered to this endpoint, in canonical order.

Platform event type: deploy.failed (a deployment failed), budget.alert (a project passed its budget alert threshold), budget.exceeded (a project reached its monthly budget cap).

Available options:
deploy.failed,
budget.alert,
budget.exceeded
createdAt
string<date-time>
required
secret
string
required

The signing secret deliveries are HMAC'd with. Shown exactly once — it is never retrievable later. Store it with the receiving service.

Pattern: ^whsec_[0-9a-f]{40}$