Skip to content

SDK Reference

The funnelgrove SDK is an HTTP API. Use the public API from funnels, mobile apps, and browser code. Use the private API only from your backend.

Base URL:

text
https://sdk-api.funnelsgrove.com

Get SDK Keys

Open the funnelgrove dashboard, select your project, then open Project Settings. Copy the SDK publishable key for public API calls and the SDK secret key for private server-side calls.

The publishable key is safe to expose in browser or mobile app code. The secret key is not; store it only on your backend.

Key rotation behavior:

KeyUsed byRotation behavior
SDK publishable keyPublic APIOld key keeps working for 30 days.
SDK secret keyPrivate APIOld key stops working immediately.

API Split

APIAuth headerUse for
Public APIX-SDK-Publishable-KeyApp subscription status checks and subscription claim after login.
Private APIX-SDK-Secret-KeyBackend reads, user lookup, user lists, and server-side subscription actions.

Required IDs

Most requests include funnelId so the API can scope the request to the right funnel. App handoff and subscription claim flows also use user_id, the funnelgrove user id passed in the deep link.