Webhooks
Get real-time notifications when events occur in your Quickbutik store
Webhooks allow your application to receive real-time notifications when important events happen in your Quickbutik store. Instead of constantly polling the API, webhooks push data to your application immediately when events occur.
Common use cases:
- Sync new orders to your fulfillment system instantly
- Update inventory levels across multiple platforms
- Send custom order confirmations or notifications
- Trigger automated workflows and integrations
How Webhooks Work
When an event occurs in your store (like a new order), Quickbutik sends an HTTP GET request to your configured webhook URL with event details as query parameters.
Quick Setup
Create webhook endpoint
Set up an endpoint in your application to receive webhook notifications
Configure in Quickbutik
Enable webhooks in your Quickbutik Control Panel under Settings → Webhooks and add your endpoint URL
Handle events
Process the webhook events in your application based on the event type
Event Structure
All webhook requests are sent as GET requests with the following query parameters:
Parameter | Description | Example |
---|---|---|
event_type | The type of event that occurred | order.new , product.update |
order_id | Order ID (for order events) | 12345 |
product_id | Product ID (for product events) | 67890 |
Example Webhook Request
Complete Example
Here’s a complete webhook handler that processes different event types:
Best Practices
Respond Quickly
Always respond with 200 OK within 10 seconds to acknowledge receipt. Process the actual work asynchronously.
Handle Retries
Webhooks may be sent multiple times if your endpoint doesn’t respond. Make your processing idempotent.
Validate Events
Verify webhook authenticity in production environments using request validation.
Error Handling
Implement proper error handling and retry mechanisms for failed webhook processing.
Important Considerations:
- Webhooks are sent as GET requests (not POST)
- Always acknowledge webhooks quickly to avoid retries
- Events may be delivered more than once - ensure idempotent processing
- Use the API to fetch complete data when processing webhooks
Testing Webhooks
Use tools like ngrok to test webhooks locally: