API Reference

Complete reference documentation for the FanFest SDK and REST APIs. Use these pages alongside the Integration Guide for implementation context.

SDK Reference

• SDK Methods -- Public methods on the FanFestSDK global: init(), trackEvent(), login(), logout(), and registerActionMapping().
• SDK Events -- Event model, TrackDataAttribute enum, TrackEventName enum, and TypeScript interfaces for tracking payloads.

REST API Reference Closed Beta

• Egress Endpoints -- Loyalty egress REST endpoints: /actions, /points, and /config.
• Webhook Payloads -- Complete payload schemas for all three resolution modes (aggregated, day aggregated, high fidelity).

Authentication

SDK methods require a valid clientId (Web App ID). REST API endpoints require an x-api-key header with the appropriate permission scope. See API Keys for key management.