HomeWiki
HomeWiki
  1. Home
  • Back to home
  • 5. Apps
  • Getting Started
  • Create App
  • Installation
  • Versioning
  • Events
  • Iframe
  • OAuth
  • Web Hooks
  1. Home

Web Hooks

Shopranos Webhooks for Apps#

Webhooks in Shopranos are a key tool for third-party app developers. By registering webhooks, your app can receive real-time updates and notifications about critical events in the Shopranos ecosystem, ensuring your app stays synchronized with changes in data such as product catalogs, orders, and more.

Key Features of Webhooks:#

Real-Time Notifications: Automatically receive updates when specific events occur.
Flexible Integration: Customize the URLs to which these notifications are sent.
Automation: Webhooks eliminate the need for continuous polling, enabling efficient and timely responses to changes.

Types of Events Supported by Shopranos Webhooks:#

1.
Order Updates: Receive notifications when there are changes to orders, including status changes or new order creation.
2.
Product Updates: Get alerted when products are added, updated, or deleted from the catalog.
3.
Brand Updates: Stay informed about changes to brand data, including new brands or modifications to existing ones.
4.
Category Updates: Monitor changes in product categories, including updates and deletions.
5.
Collection Updates: Track updates to collections, which can impact how products are grouped and displayed.
6.
Install Third-Party App: When a company installs your app, a webhook is triggered, providing details about the installation.
7.
Uninstall Third-Party App: Get notified when your app is uninstalled, allowing you to clean up any related data or configurations.

How Webhooks Work:#

1.
Setting Up Webhooks:
Specify URLs: Define the endpoints in your app where you want to receive notifications.
Event Subscription: Choose the events you want to be notified about (e.g., order updates, product updates).
2.
Receiving Notifications:
Data Payload: When an event occurs, Shopranos sends a POST request to your specified URL with a payload that includes relevant details about the event.
Custom Response: Your app can process this data and, if needed, respond with additional information or trigger other processes within your system.

App Installation Webhook#

When your app is installed, Shopranos sends an API call to the URL you specified for installation events. This call includes:
Company ID: The unique identifier of the company that installed your app.
Permissions: The permissions granted by the installer during the app installation.

Customizing Installation Data:#

Custom Dictionary: Your webhook can return a custom dictionary of data. This allows your app to include specific information that can be accessed within the Shopranos eShop via JavaScript.
Dynamic Updates: Use the Add Installation Endpoint to update this data at any time, offering flexibility in how your app manages and presents installation information.

Benefits of Using Webhooks:#

Efficiency: Real-time data updates without the need for constant polling.
Customization: Tailor the data you receive and send to suit your app’s requirements.
Scalability: Easily manage notifications and responses as your app scales across multiple installations.
By effectively utilizing webhooks, your Shopranos third-party app can maintain a seamless and dynamic integration with the eCommerce platform, ensuring up-to-date interactions with key data and events.
Previous
OAuth
Built with