Create a webhook endpoint

The secret (hws_prod_…) is returned once, in this response only. Use it to verify the Hooper-Signature header on deliveries.

POST /v1/webhook_endpoints

Create a webhook endpoint

cURL

curl --request POST \
  --url https://api.hooper.gg/v1/webhook_endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/hooks/hooper",
  "enabled_events": [],
  "description": "<string>"
}
'

201

{
  "id": "we_2",
  "object": "webhook_endpoint",
  "created": 123,
  "url": "<string>",
  "status": "enabled",
  "enabled_events": [
    "*"
  ],
  "description": "<string>",
  "secret": "hws_prod_…"
}

Authorizations

Authorization · string · header · required

API key issued by Hooper for your organization. Keys are environment-tagged: hk_prod_ keys work against production, hk_stg_ keys against staging.

Body

application/json

url · string · required

Public https URL.

Example:

"https://example.com/hooks/hooper"

enabled_events · enum<string>[]

Omit, or ["*"], for all events.

Available options: session.processed, session.failed

description · string

Response

201

application/json

Created

id · string

Example:

"we_2"

object · string

Allowed value: "webhook_endpoint"

created · integer | null

url · string

status · enum<string>

An endpoint that fails for 7 consecutive days is disabled automatically.

Available options: enabled, disabled

enabled_events · string[]

Example:

["*"]

description · string | null

secret · string

Shown once. Sign-verification secret.

Example:

"hws_prod_…"