Documentation Index
Fetch the complete documentation index at: https://docs.nippy.la/llms.txt
Use this file to discover all available pages before exploring further.
Overview
Documentation for integrating products with Nippy. Use the SDK to run gamification mechanics from your application, or connect an MCP client to query and operate internal tools with natural language.Main sections
Gamification SDK
Integrate campaigns, spins, claims, webhooks, and error handling from your backend or frontend.
MCP
Connect MCP-compatible clients to query analytics, roulettes, flows, learning, and supply.
Quickstart
SDK
Install the SDK, initialize the client, and run a spin.
MCP
Configure an MCP client with the Nippy endpoint and your API key.
SDK reference
track()
Send business events and let Nippy evaluate campaign rules.
spin()
Run an immediate spin and receive the result synchronously.
getState()
Check eligibility, cooldowns, remaining spins, and pending claims.
claim()
Confirm physical or digital prizes that require an explicit claim.
Operations and support
Authentication
Configure API keys and required headers for SDK and public API calls.
Webhooks
Verify signatures and process events emitted by Nippy.
SDK errors
Review error codes, causes, and handling patterns.
MCP errors
Diagnose common errors when using the MCP server.
For credentials and console access, use an API key with the
npk_ prefix. Do not commit it to repositories or expose it in public clients.