Skip to main content
PATCH
Update a webhook endpoint

Authorizations

x-api-key
string
header
required

API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.

Path Parameters

id
string
required

The webhook ID

Body

application/json

Webhook endpoint update payload

url
string

The HTTPS URL Creem will deliver events to.

Example:

"https://example.com/webhooks/creem"

name
string | null

A human-readable label for the endpoint. Send null to clear it.

Example:

"Production billing events"

status
enum<string>

Whether the endpoint receives deliveries. Disabled endpoints keep their configuration but receive nothing.

Available options:
enabled,
disabled
events
enum<string>[]

Event types delivered to this endpoint. An empty list means every event type.

Available options:
checkout.completed,
refund.created,
dispute.created,
subscription.active,
subscription.trialing,
subscription.canceled,
subscription.scheduled_cancel,
subscription.paid,
subscription.expired,
subscription.unpaid,
subscription.update,
subscription.past_due,
subscription.paused,
customer_credits.exhausted,
credits.granted,
credits.consumed,
credits.auto_recharged

Response

Successfully updated the webhook endpoint

id
string
required

Unique identifier for the object.

mode
enum<string>
required

String representing the environment.

Available options:
test,
prod,
sandbox
object
string
required

A string representing the object’s type. Objects of the same type share the same value.

Example:

"webhook"

store_id
string
required

The store this webhook endpoint belongs to.

Example:

"sto_1234567890"

name
string | null
required

A human-readable label for the endpoint.

Example:

"Production billing events"

url
string
required

The HTTPS URL Creem delivers events to.

Example:

"https://example.com/webhooks/creem"

status
enum<string>
required

Whether the endpoint receives deliveries. Disabled endpoints keep their configuration but receive nothing.

Available options:
enabled,
disabled
Example:

"enabled"

events
enum<string>[]
required

Event types delivered to this endpoint. An empty list means every event type.

Available options:
checkout.completed,
refund.created,
dispute.created,
subscription.active,
subscription.trialing,
subscription.canceled,
subscription.scheduled_cancel,
subscription.paid,
subscription.expired,
subscription.unpaid,
subscription.update,
subscription.past_due,
subscription.paused,
customer_credits.exhausted,
credits.granted,
credits.consumed,
credits.auto_recharged
Example:
secret
string

The signing secret used to verify delivery signatures. Only returned when the endpoint is created; retrieve it later via the secret endpoint.

Example:

"whsec_xxxxxxxxxxxxxxxxxxxx"