Integration points

While you can choose to use Bunny without any integration to your platform, you will can achieve a much higher level of automation by doing so. For example, at scale, one of the challenges for a SaaS company is keeping customer tenants in compliance with contract changes. This is a problem you can completely eliminate by using Bunny's platform provisioning capabilities.

The diagram below illustrates the four main integration points.

Bunny integration points

subscriptionCreate

This GraphQL mutation creates a subscription in Bunny. You will typically use this mutation when a user signs up for an account on your marketing website and the tenant has been created in your platform.

portalSessionCreate

To leverage Bunny's self-service capabilities, you can either embed bunny.js in your UI's code or you can create a portal session using the portalSessionCreate mutation.

tenantProvisioningChange

This webhook will update a tenant in your platform with its current features and quantities. This happens when a quote is applied to a subscription, when a customer changes their subscription in the portal or when you are changing a plan's features in the product catalog.

featureUsageCreate

If any of your plans have usage-based charges, you will be using this GraphQL mutation to create usage records in Bunny that will be the basis for the invoice that is generated at each billing cycle.

SampleSaaS reference implementation

To make it easier for developers to understand the integration points, we have open-sourced a reference integration that be downloaded from GitHub.

GitHub - bunnyapp/sample-saas: A simple multi tenant notes app for demonstrating integration with BunnyGitHub