onSaleStatusChanged

Purpose

Triggered when a sale's active status is toggled. Use this hook to track when sales are enabled or disabled.

When It Triggers

  • Owner or authorized employee toggles a sale's active status

  • Sale is enabled or disabled

Parameters

Parameter
Type
Description

data.source

number

Server ID of actor

data.shopId

string

Unique shop identifier

data.shopName

string

Display name of the shop

data.actorIdentifier

string

Identifier of person who changed

data.actorName

string

Name of person who changed

data.saleId

string

Unique sale identifier

data.saleName

string

Sale display name

data.previousStatus

boolean

Previous active status

data.newStatus

boolean

New active status

data.timestamp

number

Server timestamp

Example

Last updated