API Overview
API Overview
The Incentable Custom API lets you push data into your program from a CRM, e-commerce platform, marketing automation tool or your own system, using standard REST calls and a Bearer API key (inc_…).
Available for beta
| Page | What it covers | Status |
|---|---|---|
| RewardStar API | Issue and look up RewardStar gift cards | Available |
| Prize Draw Entries API | Enter members into a prize draw from your own system | Beta |
| Braze → RewardStar Cards | Issue cards from Braze webhooks / Canvas | Available |
| Braze → Prize Draws | Enter members into a prize draw from Braze webhooks / Canvas | Beta |
Other surfaces (members, points, rewards catalog, outbound webhooks) are not published yet. They are still being validated and will be added to these docs when they are ready for client use.
Base URL
https://us-central1-incentable-app-37d9c.cloudfunctions.net/externalApi/api/v1/external
Authentication
Include your API key in the Authorization header:
Authorization: Bearer YOUR_API_KEY
Getting your API key
API keys belong to an integration in the Admin dashboard. Choose the integration type that matches where requests come from:
| Calling from | Integration | Default permissions |
|---|---|---|
| Braze campaigns or Canvas | Braze | RewardStar write, Prize Draws write |
| Your own system (CRM, e-commerce, POS…) | Custom API | Orders read/write, Prize Draws read/write |
- Log in to the Incentable Admin Dashboard.
- Select the program you want to connect (API keys are scoped to a single program).
- Open Integrations and add (or open) a Braze or Custom API integration.
- Under Permissions & Configuration, check the permissions you need are on. Permission changes are made by Incentable — contact support if you need one changed.
- Optionally set defaults on the same page (Default RewardStar Card, Default Prize Draw) so requests can omit those ids.
- Generate the key, copy it once, and store it securely.
Optional IP allowlists and rate-limit tiers can be configured on the key.
Rate limits
Limits follow the key’s rate-limit tier. Exceeding the limit returns 429 with code RATE_LIMIT_EXCEEDED.
Errors
Errors use HTTP status codes with a JSON body. Some errors include a details object with more information:
{
"error": "Unprocessable Entity",
"message": "Entry limit exceeded: max 5 entries per member (member has 5).",
"code": "LIMIT_EXCEEDED",
"details": { "limitBreaches": ["max 5 entries per member (member has 5)"] }
}
Each API page lists the codes it can return.
OpenAPI specification
The published endpoints are described in an OpenAPI 3 file you can import into Postman, Insomnia or a code generator: openapi.yaml.
Next steps
- RewardStar API — issue and look up gift cards
- Prize Draw Entries API — enter members into a prize draw from your own system
- Braze → RewardStar Cards — issue cards from a Braze campaign or Canvas
- Braze → Prize Draws — enter members into a prize draw from Braze