Skip to content
Hooks Docs

Overview

Hooks API 1.0.0

Section titled “Hooks API 1.0.0”

Webhook forwarding API. Authenticate with Authorization: Bearer hks_... (scoped API key) or a browser session cookie. Session requests select a workspace with X-Workspace-Id. Mutating requests with a body must send Content-Type: application/json.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
GET
/v1/whoami
GET
/v1/capabilities
GET
/v1/endpoints
POST
/v1/endpoints
GET
/v1/endpoints/{id}
DELETE
/v1/endpoints/{id}
PATCH
/v1/endpoints/{id}
POST
/v1/endpoints/{id}/rotate-secret
POST
/v1/endpoints/{id}/rotate-secret/complete
POST
/v1/endpoints/{id}/test-events
GET
/v1/endpoints/{id}/destinations
POST
/v1/endpoints/{id}/destinations
GET
/v1/targets
DELETE
/v1/destinations/{id}
PATCH
/v1/destinations/{id}
POST
/v1/destinations/{id}/test
POST
/v1/destinations/{id}/test-task
POST
/v1/destinations/preview
POST
/v1/destinations/filter-preview
GET
/v1/events
DELETE
/v1/events
GET
/v1/events/{id}
GET
/v1/events/{id}/payload
POST
/v1/events/{id}/replay
GET
/v1/deliveries
DELETE
/v1/deliveries
GET
/v1/deliveries/{id}
GET
/v1/deliveries/{id}/attempts
POST
/v1/deliveries/{id}/retry
POST
/v1/deliveries/{id}/cancel
POST
/v1/replays
GET
/v1/replays/{id}
POST
/v1/replays/{id}/{action}
GET
/v1/api-keys
POST
/v1/api-keys
DELETE
/v1/api-keys/{id}
GET
/v1/workspaces
POST
/v1/workspaces
DELETE
/v1/workspaces/{id}
GET
/v1/environments
POST
/v1/environments
GET
/v1/environments/{id}/resolved
DELETE
/v1/environments/{id}
GET
/v1/secrets
POST
/v1/secrets
DELETE
/v1/secrets/{id}
PATCH
/v1/secrets/{id}
POST
/v1/secrets/migrate
GET
/v1/variables
POST
/v1/variables
DELETE
/v1/variables/{id}
PATCH
/v1/variables/{id}
GET
/v1/project
PATCH
/v1/project
GET
/v1/project/secret
POST
/v1/project/secret/rotate
GET
/v1/members
DELETE
/v1/members/{userId}
PATCH
/v1/members/{userId}
POST
/v1/invitations
DELETE
/v1/invitations/{id}
POST
/v1/invitations/accept
GET
/v1/billing/usage
PATCH
/v1/billing/settings
POST
/v1/billing/checkout
POST
/v1/billing/portal
GET
/v1/runs/{runId}
GET
/v1/tasks
POST
/v1/tasks
GET
/v1/tasks/summary
GET
/v1/tasks/templates
GET
/v1/tasks/catalog
POST
/v1/tasks/dry-run
POST
/v1/tasks/validate
GET
/v1/tasks/{name}
PUT
/v1/tasks/{name}
DELETE
/v1/tasks/{name}
PATCH
/v1/tasks/{name}
GET
/v1/tasks/runs
POST
/v1/tasks/runs
GET
/v1/tasks/runs/{runId}
POST
/v1/tasks/runs/{runId}/cancel
POST
/v1/tasks/runs/{runId}/complete
POST
/v1/tasks/runs/{runId}/rerun
GET
/v1/tasks/{engineId}/runs
GET
/v1/tasks/{engineId}/runs/{runId}
POST
/v1/tasks/{engineId}/runs/{runId}/cancel
GET
/v1/alerts/rules
POST
/v1/alerts/rules
DELETE
/v1/alerts/rules/{id}
PATCH
/v1/alerts/rules/{id}
GET
/v1/alerts/events
GET
/v1/stats
GET
/v1/metrics
GET
/v1/metrics/prometheus
GET
/v1/cli/tokens
POST
/v1/cli/tokens
DELETE
/v1/cli/tokens/{id}
GET
/v1/cli/events
GET
/v1/cli/events/{id}
GET
/v1/cli/listen
POST
/v1/cli/deliveries
GET
/v1/templates
POST
/v1/templates/{id}/apply
POST
/v1/uploads

Authentication

Section titled “Authentication”

apiKey

Section titled “apiKey”

Scoped API key, e.g. Authorization: Bearer hks_....

Security scheme type: http

sessionCookie

Section titled “sessionCookie”

Browser session cookie; mutating requests must come from a trusted origin.

Security scheme type: apiKey

Cookie parameter name: better-auth.session_token