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.
Idempotency-Key?stringA 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.
length <= 128application/json- body
url*stringYour receiver. https, on a public host. We do not follow redirects.
^https:\/\/\S+$length <= 2000events?array<>Which events to send. Leave it out to get every event type, including ones added later.
Created
application/json- response
id*stringuuidurl*stringurievents*array<>active*booleansecretPrefix*stringThe first 12 characters of the signing secret, so you can tell secrets apart.
createdAt*stringdate-timesecret*stringwhsec_ followed by 43 characters. Shown once: store it now.
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"] }'{ "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"}Set your naming template PUT
Set the naming template for every file we produce for you: the standard pattern, the GS1 Product Image Standard, Amazon's MAIN and PT01 scheme, or your own pattern from the tokens. - Override it per job with the job's naming. - File names use letters A to Z, digits, '-', '_' and '.', up to 200 characters; accented letters are converted. - The same output always gets the same name, so an updated image replaces the earlier file.
List your subscriptions GET
Your subscriptions, newest first, stopped ones included. Secrets are not included.