Skip to main content
GET
Retrieve a single event subscription by ID.

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.

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.