Connect Braze Webhooks to RewardStar Cards

Who this is for: Marketing ops and Braze admins who want Braze to issue a RewardStar gift card when a campaign or Canvas step fires.
Time to complete: About 30–60 minutes (plus QA), once Incentable credentials and a RewardStar card template are ready.

Overview

When a Braze campaign or Canvas step runs, Braze sends an automated HTTP webhook to Incentable’s Custom API. Incentable issues a RewardStar gift card, emails the recipient the card (with a redeem link), and the recipient completes redemption in the RewardStar redeem flow.

Optionally, in the same Braze multichannel campaign, you can also send a Braze push or email (for example, “Your gift card is on the way”) so the user hears from you in Braze as well as from Incentable/RewardStar.

Braze’s own docs describe a similar pattern: when a user hits a milestone or earns points, use webhooks plus your existing API to credit a reward to their account. See Create a webhook.

Prerequisites

Braze

Incentable / RewardStar

Get credentials from Incentable

1. Log in to the Incentable Admin Dashboard.
2. Select the program you want to issue RewardStar cards for (API keys are scoped to a single program).
3. Open Integrations and select (or create) your Custom API integration.
4. Enable RewardStar permissions:
   • Write — required to issue cards (rewardStar: write)
   • Read — optional, for looking up issued cards (rewardStar: read)
5. Generate the API key and store it in a secure password manager.
6. Optionally set Default RewardStar card so Braze payloads can omit cardId.

Endpoint Braze should call

The Custom API base URL is also shown under Integrations in the Admin dashboard. See the RewardStar API reference for full field and response details.

Direction: Braze → Incentable (outbound webhook). Incentable does not call Braze for this flow.

Headers

Request body for the Braze webhook composer

Field reference

Recommended Braze → payload mapping (Liquid)

Static JSON sample (for smoke tests)

{
  "member": {
    "email": "jane.doe@example.com",
    "firstname": "Jane",
    "lastname": "Doe",
    "accountKey": "CRM-100245",
    "mobile": "+61400000000"
  },
  "denomination": 50,
  "expiryDays": 90,
  "cardId": "YOUR_REWARDSTAR_CARD_ID",
  "externalRef": "braze-qa-2026-07-22-001",
  "idempotencyKey": "braze-qa-2026-07-22-001"
}

Liquid-templated JSON sample (paste into Braze)

Adjust attribute / event property names to match your Braze workspace. Keep externalRef unique for every intended card.

{
  "member": {
    "email": "{{${email_address}}}",
    "firstname": "{{${first_name}}}",
    "lastname": "{{${last_name}}}",
    "accountKey": "{{custom_attribute.${account_key}}}",
    "mobile": "{{${phone_number}}}"
  },
  "denomination": {{event_properties.${gift_card_amount}}},
  "expiryDays": 90,
  "cardId": "YOUR_REWARDSTAR_CARD_ID",
  "externalRef": "braze-{{campaign.${api_id}}}-{{${user_id}}}-{{event_properties.${reward_id}}}",
  "idempotencyKey": "braze-{{campaign.${api_id}}}-{{${user_id}}}-{{event_properties.${reward_id}}}"
}

Braze setup steps

Aligns with Braze’s Create a webhook flow. Exact UI labels can vary by Braze version.

1. Create a Webhook Campaign, or add a Webhook component in a Canvas.
2. Webhook URL: paste the Incentable issue endpoint from above.
3. HTTP method: POST.
4. Request headers:
   • Authorization: Bearer <YOUR_API_KEY>
   • Content-Type: application/json
   • Optional but recommended: Idempotency-Key with the same Liquid expression as externalRef.
5. Request body: choose JSON / raw body and paste the Liquid sample. Confirm personalization resolves from the user profile and/or trigger event properties.
6. Compose / personalization: preview with a test user so email, name, denomination, and externalRef look correct.
7. Delivery / trigger:
   • Campaign: action-based on a custom event (example: reward earned, points threshold reached), or
   • Canvas: place the webhook step after the qualification path.
8. Optional multichannel: add a Braze email or push in the same campaign/Canvas to tell the user their gift card is on the way (Incentable still sends the RewardStar card email with the redeem link).
9. Save, run a test send, then launch.

Official Braze guide: Create a webhook

How Braze retries interact with RewardStar responses

Braze retries only for certain HTTP responses (for example 408, 429, 5XX). Most other responses — including 401 Unauthorized and other 4XX — are not retried. Retry-After and X-Rate-Limit-* only affect backoff when the response is already retry-eligible; they do not create retries for non-retriable errors.

Full Braze table: Response codes and retry logic.

Success response fields

On success, Incentable returns JSON shaped like:

{
  "data": {
    "id": "issued-card-document-id",
    "status": "issued",
    "amount": 50,
    "expiresAt": "2026-10-20T00:00:00.000Z",
    "redeemUrl": "https://redeem.rewardstarcard.com/?t=...",
    "isTest": false,
    "externalRef": "braze-..."
  },
  "memberId": "member-document-id",
  "memberCreated": false,
  "message": "RewardStar card issued successfully"
}

Notes

• redeemUrl is returned on issue (POST) only. GET /rewardstar/cards/{id} lookup does not return redeemUrl.
• Braze usually does not need to store redeemUrl if Incentable emails the card to the recipient.
• 201 = new issue. 200 = idempotent replay of a previous issuance (same completed idempotency key).

Idempotency & duplicates

Because Braze may retry on 408 / 429 / 5XX, design every webhook body so a retry cannot mint a second card.

Troubleshooting

Start in Braze Message Activity / webhook error logs for the campaign or Canvas step, then map the HTTP status:

Test plan

1. Prefer a RewardStar card in test mode so QA does not draw down the fund.
2. In Braze, send a test webhook to a known inbox with a unique externalRef (for example braze-qa-<date>-001).
3. Confirm:
   • Braze shows a successful webhook delivery (201).
   • Recipient receives the Incentable/RewardStar email.
   • Card appears issued in Incentable (and isTest: true if using test mode).
4. Replay / retry simulation: send again with the same externalRef and same idempotency key.
   • Expect either 200 (idempotent replay) or 409 (duplicate externalRef) — both mean no second card was created. Confirm only one card exists.
5. Intentionally send with a bad API key.
   • Expect 401.
   • Confirm Braze does not keep retrying that failure (per Braze 4XX rules).
6. Optional: trigger a real Canvas/campaign path with a QA user before go-live.

Pre-launch checklist

• Braze package includes Webhooks (confirmed with Braze AM/CSM if needed)
• Webhook Campaign or Canvas webhook step created
• Trigger / Canvas path matches the intended reward moment
• Incentable Custom API key created; rewardStar: write enabled
• API key stored securely; used only in Authorization header (not in the URL)
• RewardStar card template active; denominations produced; branding complete
• Program fund funded or test mode used for QA then switched for production
• Default RewardStar card set or cardId included in the Braze body
• Liquid maps email, first name, last name, denomination correctly
• Stable unique externalRef (and matching idempotencyKey / Idempotency-Key) on every send
• Test send: 201, email received, one card issued
• Same-key resend: 200 or 409, still only one card
• Bad-auth test: 401, no Braze retry loop
• Optional Braze email/push copy reviewed for the multichannel campaign
• Owners know where to check Braze Message Activity and Incentable Integrations activity

Related

• RewardStar Card (Admin) — set up the card template before Braze issues against it
• RewardStar API — full issue/lookup reference
• API Overview — base URL, auth, getting your API key
• Braze — Create a webhook
• Braze — Response codes and retry logic