Webhooks in Shoporama
Guide to setting up webhooks in Shoporama that send data to external systems on certain events.
Webhooks allow you to have Shoporama automatically send a message to an external service when something happens in your shop - for example, when a new order is created. Here we'll go through what webhooks are and how to set them up.
What are webhooks?
A webhook is an automatic notification that Shoporama sends to a URL you specify when a certain event occurs. Think of it as a "reverse API" - instead of you asking Shoporama "are there any new orders?", Shoporama tells you automatically.
Without webhooks: Your service asks Shoporama every 5 minutes: "Are there any new orders?" (unnecessary load)
With webhooks: Shoporama notifies you immediately when there is a new order (efficient and real-time)
Available webhook events
You can set up webhooks for the following events:
| Event | Event description |
|---|---|
order.created | A new order has been created |
order.paid | An order is marked as paid |
order.sent | An order is marked as sent |
product.updated | A product has been updated |
Create a webhook
- Go to Settings (the gear)
- Click on the three dots and select Webhooks
- Click "Create new webhook"
- Set the URL to receive the webhook data
- Select the event you want to listen to
- Click Save
Example of webhook payload
When an event is triggered, Shoporama sends an HTTP POST request to your URL with data in JSON format. Here's an example for order.created:
{ "event": "order.created", "order_id": 12345, "webshop_id": 5842, "timestamp": "2024-01-15T10:30:00+01:00" }
Your receiving service should respond with HTTP status 200 to confirm receipt.
Using webhooks
Typical uses of webhooks:
- Warehouse integration - send new orders automatically to the warehouse
- Slack/Teams notification - get notified of new orders in your channel
- Custom integration - synchronize orders with your own system
- Automation - trigger workflows in Zapier, Make or similar
Tip to use
Use a tool like webhook.site to test your webhooks before implementing your final recipient.
Do you need help? Contact us at support@shoporama.dk.