Skip to main content
PATCH
Update Webhook
Subtotal Connector tool: update_webhook

Access

Call this endpoint with your API key, or with a Subtotal Connector OAuth token that includes webhooks:write. A token without webhooks:write receives 403 insufficient_scope. Partner app tokens don’t include it.

Example

Pause a webhook:
The response is the updated webhook, in the same shape as List webhooks.
  • Fields you omit are left unchanged.
  • event_types replaces the subscribed events. Send the full list you want.
  • Send null for purchase_date_start or purchase_date_end to clear that bound. Other fields can’t be null.
  • A new url must meet the same requirements as on create.
  • The signing secret doesn’t change.

Errors

Headers

authorization
string | null
x-api-key
string | null

Path Parameters

webhook_id
string
required

Body

application/json

Omitted fields are unchanged; explicit null clears a purchase date bound.

name
string | null
Required string length: 1 - 64
url
string | null
Maximum string length: 256
is_active
boolean | null
event_types
string[] | null

Replaces the subscribed events.

Minimum array length: 1
receive_simulated_events
boolean | null
purchase_date_start
string<date> | null
purchase_date_end
string<date> | null

Response

Successful Response

A client webhook. The signing secret is never part of this shape.

webhook_id
string
required
name
string
required
url
string
required
is_active
boolean
required
event_types
string[]
required

Subscribed event names, e.g. purchase.created.

receive_simulated_events
boolean
required

Also deliver events from the simulator.

purchase_date_start
string<date> | null
required

Only purchases on or after this date; null = unbounded.

purchase_date_end
string<date> | null
required

Only purchases on or before this date; null = unbounded.

created_at
string<date-time>
required