Skip to main content

ProductsPurchasedWebhook

The products purchased webhook is called when products are purchased at the cash register.

Details
TypeHTTP POST request with a JSON body to your URL
AfterImmediately after session at the cash register is completed.
Configuration variablesList of product IDs that you would like to receive webhooks for
AuthenticationSignature in X-Signature header: Read more

Data Schema

{
sales: Record<string, number>
}

Sales for the product are sent in an object with the product ID as key and the number of products of that type as a number.

Example POST Body

{
sales: {
"33": 5,
"89": 8
}
}

In this example, there were 5 sales of product 33 and 8 of product 89.