Gleam Developer Documentation
Add Gleam feedback, roadmap, updates, and notification surfaces to your product with the supported iOS SDK, Web Portal, and SDK REST v1 APIs.
Choose Your Integration Path
Most teams should start with the hosted Portal link or the iOS SDK Portal UI. Those paths give users a complete feedback, roadmap, and updates surface without requiring you to build a native feedback system first.
Use the SDK REST v1 APIs only when you need a native announcements list, notification inbox, push preferences, or explicit APNs token registration.
AI Agent Setup
Generate a scoped prompt for Codex, Cursor, Claude Code, or another coding agent to add the SDK and selected capabilities.
iOS SDK
Install the Swift package, configure it with the project ID and SDK key from the dashboard, then present the Portal from SwiftUI or UIKit.
Web Portal
Link, iframe, or sidebar-launch the hosted Portal for web products that need a low-maintenance feedback entry point.
SDK REST v1
Reference the endpoints used by the iOS SDK for sessions, announcements, notification preferences, and APNs device tokens.
Production Checklist
Before shipping, verify that the project ID and SDK key come from the correct Gleam project, that signed identity secrets stay on your server, and that APNs credentials are configured only when you intend to deliver native push.
Create or select a Gleam project
Open the dashboard, choose the project, and copy the project ID plus SDK initialization key from Settings -> Integrations.
Install the client surface
Use Swift Package Manager for iOS or link to the hosted Portal for web. Do not embed server-only secrets in client code.
Decide on identity
Anonymous sessions work by default. For signed-in users, generate a short-lived HS256 identity token on your backend.
Verify notification behavior
Use polling for in-app notifications. Add APNs registration only after the app owns permission and notification-center routing.
Supported Surface
This developer documentation focuses on the SDK and Portal integration surfaces. AI Native MCP tools and Gleam Skills are part of Gleam's agent workflow, while management APIs and outbound webhooks are not documented as production integration surfaces here.
- Portal WebView UI for feedback, roadmap, and announcements.
- Anonymous and signed identity sessions.
- Announcements Data API and latest announcement lookup.
- Notification inbox polling and push notification preferences.
- APNs device token register, unregister, and notification deep-link routing.