RetailLink
OverviewGetting startedA–Z indexAdmin overviewAdmin pagesAdmin settingsPOS overviewPOS screensStorefrontMerchant APIObjectsAuthenticationWebhooks

Object

Webhooks

webhook_event

Payload delivered to a merchant webhook endpoint.

POSTed to your HTTPS URL with X-Webhook-Signature. Manage subscriptions in Admin → Settings → API credentials.

Exposure

Delivered in webhook POSTs — not a Merchant API list resource.

What

The webhook_event object is the JSON / domain shape for this resource in RetailLink.

Why

Use these fields when integrating — not scraped Admin HTML — so sync jobs and apps stay stable across UI changes.

How

Read each property below — description first, then that property's Code / Data / Output (or type). Use the sticky example JSON on the right as a full fixture.

Properties

5 fields on webhook_event. Types link to related objects when available. Snippets for a property appear under that property.

id

string

Event id.

Type
id: string

topic

string

Event topic such as order.created, product.updated, customer.created.

if (event.topic === "order.created") {
  // sync order
}

shopId

string

Shop that produced the event.

Type
shopId: string

createdAt

string

ISO-8601 event time.

Type
createdAt: string

data

object

Topic-specific payload (ids and summary fields).

Type
data: object

Related