Reference
Look up OfferKit object relationships, data conventions, API behavior, rule inputs, developer tools, and retry handling while building an integration.
Use the goal and integration guides to design an implementation. Use this section when you need the exact name, representation, convention, or interface.
Developer surfaces
- SDK, REST, CLI, and MCP
- API conventions and live OpenAPI
- The running deployment’s OpenAPI 3.1 document at
/api/openapi.json
Concepts and behavior
- How objects connect
- Rule inputs and operators
- Retries, refunds, and recovery
- Glossary and data conventions
- How OfferKit works
- Webhook payload and delivery behavior
- Troubleshooting reason codes
Important representations
- Monetary values are integer minor units:
1000USD means USD 10.00. - Percentages and earning multipliers use basis points:
1000is 10%;10000is 1× or 100%. - IDs minted by OfferKit are UUIDs unless a resource explicitly uses a human code.
- Dates are ISO 8601 timestamps at API boundaries.
- List cursors are opaque and must be returned unchanged.
- API keys and webhook secrets are plaintext only when first created.
Docker and platform setup
Run the published OfferKit Docker image locally or on Railway, configure Postgres and Redis, and start the web and worker services without a source build.
How objects connect
Trace how OfferKit customers, campaigns, vouchers, loyalty programs, and referral rewards connect, including links your application must create itself.