​

Incentives

​

What you see on the page

• Reward type — Discount code, Gift card, Custom / manual, or Account credit
• Reward source — where a code-backed reward draws its code from, or automatic
• Contact ID or Recipient email — one of the two identifies the recipient
• Amount and Currency for value-bearing types
• Reference (optional) — an order id, ticket id, or campaign to attach to the record

​

Who can read and who can act

​

Worked examples

​

Mint a one-off support credit

1. Choose Issue incentive.
2. Set Reward type to Account credit, enter the amount and currency, and set the member’s Contact ID.
3. Put the ticket number in Reference so the ledger row is traceable later.
4. Confirm. The row appears with status issued and source marking the standalone path.

​

Redeem versus void a standing reward

• Choose Redeem on an issued row to mark the reward used. The confirmation warns this cannot be undone.
• Choose Void to cancel a reward you no longer want redeemable, for example a credit issued to the wrong contact. Voided rows stay in the ledger so the audit trail holds.

​

Audit one member’s rewards

1. Put the member’s id in Contact ID and choose Apply.
2. Switch Status to Issued to see what they still hold, or to Redeemed to see what they actually used.
3. A promotion that shows many issued and few redeemed rows is an offer that did not convert; the source column tells you which program or one-off mint produced it.

​

API pairing

curl -X POST https://api.orbit.devotel.io/api/v1/incentives/issue \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "reward_type": "custom",
    "source_ref": "ticket-4821",
    "recipient": { "contact_id": "cnt_member_9x2" },
    "amount": 100,
    "metadata": { "reason": "win-back" },
    "idempotency_key": "winback-cnt_member_9x2"
  }'

import { Orbit } from "@devotel-orbit/node";

const orbit = new Orbit({ apiKey: process.env.ORBIT_API_KEY! });

const { data: reward } = await orbit.request<{
  id: string;
  status: "issued" | "redeemed" | "voided";
}>("POST", "/incentives/issue", {
  body: {
    reward_type: "custom",
    source_ref: "ticket-4821",
    recipient: { contact_id: "cnt_member_9x2" },
    amount: 100,
    metadata: { reason: "win-back" },
    idempotency_key: "winback-cnt_member_9x2",
  },
});

console.log(reward.id, reward.status); // issued → redeemed | voided

​

Tenant-owned controls