Skip to main content
PATCH
Partially update an event subscription. Omitted fields keep their current value — only send the fields you want to change. To change authentication, send the full authentication object; omit it entirely to leave authentication unchanged, or send {"type": "NONE"} to clear it.

​
Pausing and resuming deliveries

Send {"active": false} to stop deliveries for a subscription, and {"active": true} to start them again. Pausing keeps the subscription’s id, signing secret and delivery history intact, so you don’t need to delete and recreate it — useful while you deploy a change to your endpoint or investigate a failure. While a subscription is paused, events that occur are not queued for later delivery. You will not receive them after resuming, so re-sync any affected products with List Products once you’re back up.

Authorizations

​
Headout-Auth
string
header
required

Path Parameters

​
id
string
required

Identifier of the event subscription, e.g. whsub_01j.... Returned as id from Create event subscription and List event subscriptions.

Body

application/json

Partial update — omitted fields keep their current value.

​
url
string<uri>

HTTPS URL Headout will deliver events to. Omit to keep the current value.

Pattern: ^https://.*
​
eventTypes
enum<string>[]

Event types to subscribe to. Omit to keep the current value; if present, must be non-empty with no duplicates.

Minimum array length: 1

The event types available for subscription:

  • product.listing_status_changed — A product was listed or unlisted.
  • product.variant_listing_status_changed — One or more variants under a product were listed or unlisted. Fires when a product is listed (its variants arrive as listed) or delisted (all its variants are reported delisted), and also while a product stays listed but individual variants under it are listed or delisted.
  • product.data_changed — The content of a product that is listed (and was listed at the previous sync) changed. data.changedFields names which fields differ. Listing/unlisting and variant add/remove are reported by the two events above, not here.
  • product.variant_pricing_changed — The near-term pricing of a variant under a listed product changed for a specific date. data names the productId, variantId, and date whose price moved, not the new amounts — re-fetch the price to read them.
Available options:
product.listing_status_changed,
product.variant_listing_status_changed,
product.data_changed,
product.variant_pricing_changed
​
authentication
object

Authentication Headout attaches to webhook deliveries for this subscription. Tri-state on update: omit this field entirely to keep the current authentication unchanged, send {"type": "NONE"} to clear it, or send {"type": "AUTHORIZATION_HEADER", "value": "..."} to set it.

​
description
string

Optional free-text label. Omit to keep the current value.

Maximum string length: 500
​
active
boolean

Pause or resume delivery. false stops deliveries for this subscription; true resumes them. Omit to keep the current value. Pausing keeps the subscription's id, signing secret and delivery history intact — you do not need to delete and recreate it.

Response

Successful response

​
id
string

Identifier of this subscription, e.g. whsub_01j.... Use in Get/Update/Delete/Rotate secret.

​
url
string

HTTPS URL events are delivered to.

​
eventTypes
enum<string>[]

Event types this subscription is subscribed to.

The event types available for subscription:

  • product.listing_status_changed — A product was listed or unlisted.
  • product.variant_listing_status_changed — One or more variants under a product were listed or unlisted. Fires when a product is listed (its variants arrive as listed) or delisted (all its variants are reported delisted), and also while a product stays listed but individual variants under it are listed or delisted.
  • product.data_changed — The content of a product that is listed (and was listed at the previous sync) changed. data.changedFields names which fields differ. Listing/unlisting and variant add/remove are reported by the two events above, not here.
  • product.variant_pricing_changed — The near-term pricing of a variant under a listed product changed for a specific date. data names the productId, variantId, and date whose price moved, not the new amounts — re-fetch the price to read them.
Available options:
product.listing_status_changed,
product.variant_listing_status_changed,
product.data_changed,
product.variant_pricing_changed
​
description
string | null

Free-text label for this subscription, if set.

​
active
boolean

Whether this subscription is currently active.

​
createdAt
string<date-time>

When this subscription was created.

​
updatedAt
string<date-time>

When this subscription was last updated.

​
authentication
object
​
signingSecret
string | null

Signing secret for this subscription, used to verify the X-Headout-Signature header on delivered events. Only present in the response to Create event subscription and Rotate signing secret — never returned again afterwards, so store it immediately.

​
signingSecretHint
string | null

Masked trailing characters of the current signing secret, returned on reads so you can tell which secret is active without exposing it.