SalesPlay POS Webhook

What is a Webhook?

A webhook is a way to get real-time updates from the SalesPlay POS system. It helps your system or app stay updated automatically when something changes in SalesPlay , like when stock levels are updated or a new product is added.

Instead of checking (polling) for updates again and again, webhooks send data to you instantly when something happens.

Benefits of Using Webhooks

SalesPlay POS supports webhooks. Developers can use this feature to integrate with external systems and receive real-time event notifications.

What Can Webhooks Do?

SalesPlay webhooks provide real-time notifications for key events in the POS system. You will receive updates when a receipt is created or updated, ensuring all sales records are promptly captured. Notifications are also sent when the stock or inventory of a product is updated, helping you manage inventory levels efficiently. Additionally, you’ll be alerted when a customer is created, edited, or deleted, keeping your customer database accurate. Finally, the system notifies you when a credit note or cash refund is created or updated, allowing you to track returns and refunds with ease.

You can receive notifications when the following events happen:

How to Add a Webhook

You can set up webhooks in two ways:

1. Using API

Use the /webhook endpoint to add webhook via API.
(For developers: visit SalesPlay Developer Portal)

2. Using Web Interface

Go to: https://cloud.salesplaypos.com/webhooks_setup

Each webhook can subscribe to only one event type. (Recommends)
The webhook URL must be unique for each event.( Recommends)

Important:

Webhook Payload Example

When an event happens, SalesPlay will send a POST request to your webhook URL with event data in JSON format.

Example: for inventory_levels.update event

json

CopyEdit

{

"merchant_id": "WFpYWmQwMkJGVWtDT3RHY1NHYjdBT0YzZE5xOD0=",

"type": "inventory_levels.update",

"created_at": "2025-06-30 12:54:31",

"inventory_levels": [

{

"product_id": "QWhxek54UkQ3eTArdml2d1NkSDVnUT09",

"shop_id": "bHF2M2pMakkzTVZ0NFh2SE1WNnNoUT09",

"product_code": "10003",

"in_stock": 10

}

]

}

Test Your Webhook

You can test the webhook during setup:

SalesPlay will send a sample POST request to check if your URL is working.

Timeouts and Retry Rules

Learn More