Reference
Find OfferKit integration conventions, interfaces, terminology, authentication rules, idempotency behavior, webhook details, and runtime guidance.
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
- 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.
Deploy OfferKit
Deploy OfferKit's web application and worker with Postgres and Redis, using local containers or a production platform that fits your stack.
SDK, REST, CLI, and MCP
Choose between OfferKit's TypeScript SDK, REST API, CLI, and MCP server based on runtime, automation, authentication, and operational needs.