Use Spiffy’s public API for private integrations on your Spiffy account, or to build third-party integrations through our developer program.
You’ll find your API Settings for private integrations in your Spiffy account under Account Settings > API.
Usage
Track your monthly usage of API requests made by integrations connected to your account. These requests count toward your account’s standard API usage limits, based on your Spiffy plan tier.
Credentials
Create and view your account’s API key, to authenticate requests to the Spiffy API.
Your API key is account-scoped and should be treated like a password. Do not expose it in client-side code, public repositories, or unsecured environments.
If your key is compromised or needs to be rotated, use Regenerate to create a new key. Regenerating a key immediately invalidates the previous key.
Webhooks
Configure webhook endpoints that receive real-time event notifications from Spiffy such as order activity, subscription changes, or other account updates. Each endpoint receives event payloads when subscribed events occur.
To add a webhook endpoint:
- Select Add Destination.
- Enter the Webhook URL and a description.
- Toggle on Event Subscriptions to allow the webhook to listen to all events, or toggle it off and select the specific automation events you want connected.
- Select Create Destination
Developer Program
If you’re creating a third-party integration such as a plugin, SaaS integration, or marketplace app you can apply to the developer program to access the tools needed to build and distribute applications. Once approved, you’ll be able to create apps that connect to Spiffy accounts using the developer platform.
Private Integrations vs Third-Party Integrations
| If you’re building… | Use this: |
| Internal tools for your own business | Private Integration |
| Automation scripts running on your infrastructure | Private Integration |
| A product other businesses will connect to | Third-Party Integration |
| A marketplace or publicly distributed app | Third-Party Integration |