Getting Started
High-level overview of Bubblehouse APIs
Bubblehouse is a highly customizable loyalty solution offering an array of pre-built applications and integrations. We generally undertake the setup for you, eliminating the need for additional work or significant IT involvement.
Nonetheless, if you wish to incorporate Bubblehouse into a tailor-made online shopping platform or to offer a bespoke user experience, you are going to use our Application Programming Interfaces (APIs) detailed in this document.
APIs
The functionality of our platform is grouped into multiple APIs based on use cases, calling conventions and authentication requirements.
Loyalty APIInteract with the loyalty program on a customer’s behalf.
You can read a state of the customer’s points, tier, achievements, etc, and perform actions like redeeming points or using an achievement.
Loyalty API is typically called from the client side, although you can also invoke it from your servers.Loyalty Admin APIApply manual adjustments to the customer’s loyalty program.
Similar to Loyalty API, all functions of this API target a single customer. These require admin authentication and are only available to your staff.Order APIPush order and customer information to Bubblehouse.
If you’re using a built-in integration like Shopify or BigCommerce, this is already handled for you.
Otherwise, you need to call this API from your server whenever an order is placed or updated, or a customer signs up or updates their details.Hooks APISet up API endpoints on your servers that Bubblehouse will call.
Unless you’re using a builtin integration like Shopify or BigCommerce, at the very least you need to provide a Create Discount hook.
Additionally, hooks can be used to monitor key loyalty events. Hooks are enabled on a case-by-case basis; talk to your sales rep if you need extra callbacks.Blocks APIExposes built-in user interface blocks you can embed into your site.
Returns HTML fragments that you can embed via an IFRAME.
Allows you to deliver the UI of the loyalty program quickly. A great alternative to implementing an entirely custom user experience via Loyalty API.Block Client APIImplement client-side JavaScript functions that will be called by blocks embedded via Blocks API.
This is a postMessage-based communication protocol between our embedded blocks and your outer web site.Triggers APIUse custom user actions to grant points, advance/unlock tiers, and more.
Allows you to build a more advanced loyalty program. Call this API to notify Bubblehouse when your customers perform relevant actions.
Triggers API can be called from your server or from the client side with an appropriate authorization.Analytics APIGet raw data from Bubblehouse to power your own analytics.
If you have a data science team or a third-party dashboards/analytics provider, you can ingest Bubblehouse data into your analytics pipeline.
You can read a state of the customer’s points, tier, achievements, etc, and perform actions like redeeming points or using an achievement.
Loyalty API is typically called from the client side, although you can also invoke it from your servers.Loyalty Admin APIApply manual adjustments to the customer’s loyalty program.
Similar to Loyalty API, all functions of this API target a single customer. These require admin authentication and are only available to your staff.Order APIPush order and customer information to Bubblehouse.
If you’re using a built-in integration like Shopify or BigCommerce, this is already handled for you.
Otherwise, you need to call this API from your server whenever an order is placed or updated, or a customer signs up or updates their details.Hooks APISet up API endpoints on your servers that Bubblehouse will call.
Unless you’re using a builtin integration like Shopify or BigCommerce, at the very least you need to provide a Create Discount hook.
Additionally, hooks can be used to monitor key loyalty events. Hooks are enabled on a case-by-case basis; talk to your sales rep if you need extra callbacks.Blocks APIExposes built-in user interface blocks you can embed into your site.
Returns HTML fragments that you can embed via an IFRAME.
Allows you to deliver the UI of the loyalty program quickly. A great alternative to implementing an entirely custom user experience via Loyalty API.Block Client APIImplement client-side JavaScript functions that will be called by blocks embedded via Blocks API.
This is a postMessage-based communication protocol between our embedded blocks and your outer web site.Triggers APIUse custom user actions to grant points, advance/unlock tiers, and more.
Allows you to build a more advanced loyalty program. Call this API to notify Bubblehouse when your customers perform relevant actions.
Triggers API can be called from your server or from the client side with an appropriate authorization.Analytics APIGet raw data from Bubblehouse to power your own analytics.
If you have a data science team or a third-party dashboards/analytics provider, you can ingest Bubblehouse data into your analytics pipeline.