Skip to Content

Change a subscription

Needs the scope webhooks:manage

Change the URL or the event types of a subscription.

Path Parameters

webhook_id*string

The id from POST /api/v1/webhooks.

Formatuuid

Request Body

application/json
  1. body
url?string

A new receiver address.

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

The event types to receive from now on. The same names as when you create a subscription.

Response Body

OK

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
Example Request
curl -sS -X PATCH https://platform.charpstar.co/api/v1/webhooks/$WEBHOOK_ID \  -H "Authorization: Bearer $CHARPSTAR_API_KEY" \  -H "Content-Type: application/json" \  -d '{ "events": ["asset.approved", "status.changed"] }'
Example Response
{  "id": "a1b2c3d4-0000-4000-8000-000000000001",  "url": "https://example.com/charpstar/events",  "events": [    "asset.approved",    "status.changed"  ],  "active": true,  "secretPrefix": "whsec_Q2x9Ab",  "createdAt": "2026-10-20T08:00:00.000Z"}