EFIQ Rewards API
Create unique, trackable reward links from any CRM or application. Each link gives one person one reward from your campaign, and tells you when it’s opened, claimed and redeemed.
Quickstart Create your first link in five minutes.Authentication Account SID, Auth Token and API keys.Services One per integration, with its own settings.Webhooks Signed events for opens, claims and more.Paying for links API calls are free. Plan links first, then the ones you buy.Privacy and data Pseudonymous by default, erasure on request.
Concepts
- Account (
AC…): your business account, the same one you use in the EFIQ campaigns dashboard. - Campaign (
CP…) and rewards (RW…): what a link can give and how often each reward comes up. Manage them in the portal. - Service (
RS…): one integration, such as your HubSpot account or mobile app. It sets the default campaign, link expiry and webhooks. - Link (
LK…): one unique URL likehttps://rewards.efiqone.com/g/2kTq8VbnP4xWfor one person, identified by your ownExternalUserId.
Conventions
- Base URL:
https://api-rewards.efiqone.com/v1(locallyhttp://localhost:4100/v1). - Requests take form-encoded fields in PascalCase (
ExternalUserId) or JSON in camelCase (externalUserId). Responses are JSON with snake_case fields. - Dates are RFC 3339 in UTC. Lists use
PageSizeandPageToken. - Send an
Idempotency-Keyheader on every POST; a retry with the same key returns the first response for 24 hours. - Errors have an HTTP status, a numeric
code, amessageand amore_infolink. See Errors.