Skip to main content
PATCH
Update webhook endpoint

Authorizations

Authorization
string
header
required

Pass Authorization: Bearer scripe_sk_live_<...> (or scripe_sk_test_<...> for test keys) on every request. Keys are scoped to a single workspace and can be revoked from the Scripe dashboard.

Headers

Scripe-Api-Version
string

Pin the API version. Format YYYY-MM-DD. Omit to receive the currently rolling default. Unknown versions return 400 version_unsupported.

Example:

"2026-08-01"

Path Parameters

endpointId
string
required
Example:

"whe_a1b2c3d4e5f6g7h8"

Body

application/json
name
string
Required string length: 1 - 128
url
string<uri>
Maximum string length: 1024
events
enum<string>[]
Minimum array length: 1

Closed list of subscribable events. Adding a new event name is a contract change — bump the docs + this enum in lockstep with the producer.

Available options:
note.created,
post.created,
post.updated,
post.scheduled,
post.unscheduled,
source.created,
job.completed,
job.failed,
knowledge.indexed
isActive
boolean
projectId
string | null

Response

Endpoint updated.

data
object
required

Display-safe shape of a webhook endpoint. The plaintext signing secret is never present here — only secretLast4. Use WebhookEndpointWithSecret (returned by create + rotate) when the plaintext matters.