Gleam Developer Documentation
Add Gleam feedback, roadmap, updates, and notification surfaces to your product with the hosted Portal, iOS SDK UI, and SDK APIs for custom native experiences.
Last reviewed June 2, 2026
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 SDK APIs when your app needs a fully custom SwiftUI or UIKit experience: render your own feedback board, announcement feed, notification inbox, preference controls, or push routing while keeping Gleam sessions, no-login submission, moderation, and follow-up on the server.
AI Agent Setup
Generate a scoped prompt for Codex, Cursor, Claude Code, or another coding agent to add the SDK features you choose.
iOS SDK
Install the Swift package, then choose the hosted Portal preset or build native feedback, announcement, and notification screens with SDK APIs.
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, feedback, announcements, notifications, 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.
What This Covers
These docs cover the supported SDK and Portal surfaces. AI Native MCP tools and Gleam Skills live in the agent workflow. Management APIs and outbound webhooks are not part of the production integration docs yet.
- Portal WebView UI for feedback, roadmap, and announcements.
- Anonymous and signed identity sessions.
- Native feedback Data API for boards, posts, votes, and comments.
- Announcements Data API for custom changelog and latest-update surfaces.
- Notification inbox polling, push notification preferences, and APNs deep-link routing.
- APNs device token register, unregister, and notification deep-link routing.