Webhooks

OpenTiendas webhooks enable seamless integration with external systems (ERP, CRM, custom applications, etc.) by delivering real-time notifications when key events occur —such as order creation or review publication.

info

Webhook management is only available to users with the Store Manager role or higher, and exclusively on plans eShop and eBusiness.

Setting Up Webhooks

Webhooks are enabled directly from your OpenTiendas Admin Panel. Learn how to create and manage your webhooks in the Getting started section.

How Webhooks Work

Webhooks send JSON payloads to your specified URL whenever an event occurs. This enables seamless integration with your external systems, allowing for actions such as syncing data or triggering workflows.

Webhook payloads follow a standardized envelope structure that includes event metadata and the resource data:

• event_id: Unique event identifier (useful for idempotency)
• type: Event type (e.g., order.created)
• created_at: Timestamp of the event
• data: The actual resource payload (Order, Review, etc.)

See the Event Reference for full payload examples.

tip

Use the id field to implement idempotent processing and avoid handling duplicate webhook deliveries.

Security and Validation

• All webhook notifications are signed using HMAC SHA256 to ensure authenticity.
• Each webhook has a unique secret key used to generate the signature.
• For detailed info on webhook signatures and security, refer to the Security Guide. You can also explore webhook receiver examples on Sample code page

Retry Logic

• The system attempts to deliver the webhook up to 5 times:
• Each webhook has a 5-second timeout for responses.
• Learn more in the Retries and error handling section

Available Events

Event	Description
order.canceled	Triggered when an order is canceled.
order.created	Triggered when a new order is created.
order.fulfilled	Triggered when an order is fulfilled.
order.paid	Triggered when an order is paid.
review.created	Triggered when a new review is created.
review.published	Triggered when a review is published.

Refer to the Event Reference page for complete details and payload examples.

Code Samples

Explore complete webhook receiver examples in different languages.
Check out the Sample Code section for detailed examples in Python, Node.js, .NET, and more.