Skip to Content

Subscribe to events

Needs the scope webhooks:manage

Subscribe your https URL to signed events. Up to 3 active subscriptions. The answer carries the signing secret once: store it next to your API key. Leave events out to receive every type, including ones added later.

Header Parameters

Idempotency-Key?string

A unique value such as a UUID. A retry with the same key within 24 hours returns the original answer and runs nothing twice; the same key with a different body is refused with 409 idempotency_conflict.

Lengthlength <= 128

Request Body

application/json
  1. body
url*string

Your receiver. https, on a public host. We do not follow redirects.

Match^https:\/\/\S+$
Lengthlength <= 2000
events?array<>

Which events to send. Leave it out to get every event type, including ones added later.

Response Body

Created

application/json
  1. response
id*string
Formatuuid
url*string
Formaturi
events*array<>
active*boolean
secretPrefix*string

The first 12 characters of the signing secret, so you can tell secrets apart.

createdAt*string
Formatdate-time
secret*string

whsec_ followed by 43 characters. Shown once: store it now.

Example Request
curl -sS https://platform.charpstar.co/api/v1/webhooks \  -H "Authorization: Bearer $CHARPSTAR_API_KEY" \  -H "Content-Type: application/json" \  -d '{ "url": "https://example.com/charpstar/events", "events": ["asset.approved", "asset.images.updated"] }'
Example Response
{  "id": "a1b2c3d4-0000-4000-8000-000000000001",  "url": "https://example.com/charpstar/events",  "events": [    "asset.approved",    "asset.images.updated"  ],  "active": true,  "secretPrefix": "whsec_Q2x9Ab",  "createdAt": "2026-10-20T08:00:00.000Z",  "secret": "whsec_Q2x9AbF0dKe7LmN3pR5sT8uV1wX4yZ6aB9cD2eF5gH8"}