What are Webhooks
Webround Webhooks are the most efficient way to synchronize your external systems with your store's events in real time. Instead of constantly polling our APIs, Webround will send notifications to your server as soon as a relevant event occurs.
Why listen to webhooks
Listening to webhooks allows you to automate complex workflows without latency:
- ERP/Logistics Sync: Send an order to the warehouse as soon as it is paid.
- Custom Notifications: Send a personalized email or Slack message to your customers.
- Data Analysis: Update your BI database in real time without overloading the APIs.
How Webround integrates webhooks
Webround does more than just send data; it provides an enterprise-level auditing and dispatching infrastructure, implemented with proprietary systems and high-performance queues.
- Reliability and Queues: We use advanced messaging systems to handle traffic volumes, ensuring every event is processed correctly.
- Idempotency: Every event is uniquely marked, allowing your system to ignore any duplicates.
- Deliverability: We manage automatic retries in case of server errors, ensuring data reaches its destination.
You can replay events in the "Events" section of the Webhooks page within your Webround Commerce dashboard. Click on an event and select "Send again" to receive the event once more.
Available events
You can register an event endpoint directly from the Webround Commerce dashboard. Access your store, select Webhooks from the sidebar, and you are ready to start.
Configuration
You can perform a granular configuration of which events to listen to for each individual webhook. At the time of creation, you must link an endpoint (URL) of your choice. Webround will send a POST request to the specified address with a JSON payload representing a snapshot of the entity and its relations at the exact moment the event occurred.
Security and Secrets
During configuration, you will be shown a Signing Secret.
Store this secret carefully. It will never be shown to you in plain text again.
To ensure maximum security, we encrypt your secret and decrypt it exclusively at the internal process level during the payload signing phase. It is never logged or exposed, ensuring that only our dispatch system can generate a valid signature for your data.
Always ensure you have the expertise and knowledge of what happens at the endpoint receiving your store's events. Webround does not send sensitive data, but it may send signed payloads and customer data, such as in the case of account deletion requests or when saving new shipping addresses for a specific customer.
Webround is only responsible for forwarding data based on your configuration. Once data leaves the platform, it is your complete responsibility to ensure its integrity and correctness, as well as compliance with current user privacy regulations.
Monitored Entities
Currently, you can subscribe to events related to:
- Orders: Creation, status updates, payments, and refunds.
- Store Customers: Registrations, profile updates, and account verifications.
- Products, Variants, SKUs: Product creation, price changes, stock, and variant attributes.
- Subscriptions: Full lifecycle management of recurring subscriptions.
Data Types
Every event sent by Webround uses this format, attaching a specific schema for the internal payload.
| Field | Type | Description |
|---|---|---|
| envelopeId | uuid | Unique identifier of the message (Payload ID) |
| eventType | enum | Type of event triggered (e.g., order.created, order.paid, etc.) |
| initiatedBy | email, null, undefined | Email of the user or system that generated the action |
| storeId | uuid | Unique identifier of the associated store |
| occurredAt | isoDate | ISO 8601 timestamp of the exact moment the event occurred |
| eventId | string | Unique ID of the event, usable as an idempotency key |