Merchant-facing API
Appolar does not currently expose a public API for merchants. All configuration is done through the visual builder in your Shopify admin. There is no REST or GraphQL API for reading or writing builder configuration programmatically at this time.
If you have a use case that requires programmatic config updates — for example, you want to update a featured collection ID via a Shopify Flow trigger, or sync your app layout with a seasonal campaign calendar — contact support to discuss. This is a planned capability for a future release, and describing your specific use case helps prioritize what to build first.
Shopify webhooks (internal)
Appolar subscribes to a set of Shopify webhook topics on your store's behalf when you install the Shopify app. These are internal webhooks that drive Appolar's own infrastructure — they are not configurable or directly visible from the builder. You do not need to create or manage these webhooks yourself.
| Webhook topic | What Appolar does with it |
|---|---|
app/uninstalled | Marks your account as uninstalled and pauses any active build queue entries |
orders/create | Triggers push notification dispatch to the customer for order confirmation (transactional) |
orders/updated | Updates order status in the app's order history cache and triggers shipping/fulfillment push notifications |
products/update | Invalidates CDN cache for product configuration data so apps pick up changes on next load |
shop/update | Syncs store name and currency changes to Appolar's configuration record for your store |
Your app reads most data live from the Shopify Storefront API on each screen load. Webhooks are used only for push notification triggering and cache invalidation — not as a primary data source. If a webhook delivery fails, the worst case is a slightly stale cache entry or a delayed push notification. The app self-corrects on the next Storefront API call.
Builder API (planned)
A public API for reading and writing builder configuration is planned for merchants with advanced automation needs. Intended use cases include:
- Syncing a featured collection block with a Shopify Metaobject that your team updates seasonally
- Triggering a rebuild via a CI/CD pipeline when your Shopify theme ships a major update
- Reading analytics event counts programmatically to build a custom internal dashboard
- Updating push notification campaigns via a third-party automation tool
No timeline is set for this. If programmatic access to builder configuration is a priority for your store, open a support ticket and describe your use case. Interest from merchants directly shapes what gets built.