Webhook

📡 Real-time Notifications

Configure webhook endpoints that receive real-time notifications from the SoftPOS system. Webhooks enable external systems to automatically react to important changes without the need for continuous polling, making integrations more efficient and reliable.

⚡ Instant Updates

A webhook is an automated HTTP POST notification sent by the system to a configured URL when a relevant event occurs. Instead of repeatedly requesting updates, your system receives information instantly when something changes.

Why Use Webhooks with SoftPOS?

Real-time Communication

Receive updates as soon as system events occur

Reduced API Usage

Eliminates the need for frequent status checks

Automation Support

Enables automatic processing and synchronization

Scalable Integrations

Suitable for high transaction volumes

How Webhooks Work

Webhook Flow Process

The general webhook flow is as follows:

Configure Webhook URL - A webhook URL is configured in the dashboard
Event Occurs - A system event occurs
POST Request - SoftPOS sends an HTTP POST request to the configured URL
Process Data - The receiving system processes the data
Confirm Delivery - A successful response confirms delivery

Webhook Configuration

Configuration Settings

From the Webhook Management page, users can configure webhook settings by defining:

Webhook URL
The endpoint that will receive notifications
Webhook Category
Used to organize webhook configurations
Webhook Event
Used to define when notifications are sent

Webhook Actions

Available Actions

The Webhook Management page supports the following actions:

✅ Add webhook URL
✏️ Edit webhook URL
🗑️ Delete webhook URL
🔄 Enable or disable webhook configurations
📊 Monitor webhook delivery attempts
♻️ Retry webhook delivery when applicable

Security & Reliability

Security Requirements

To ensure secure communication:

• Webhook endpoints must be publicly accessible
• HTTPS with a valid SSL certificate is required
• Webhook URLs should be protected and monitored

Reliability and Delivery

Webhook delivery is designed to be reliable:

• Notifications are sent using HTTP POST requests
• The receiving endpoint should return a successful HTTP status
• Retry mechanisms help ensure delivery in case of temporary failures

Extending Webhook Usage

Webhook configurations can be extended to support additional use cases as system capabilities expand.

Detailed documentation for payload structures and trigger conditions will be provided separately.