ChangelogRelease History
Changelog

Changelog

Latest updates and improvements to the Flameup API

Changelog

Stay up to date with the latest changes to Flameup.


2024-12-07v1.0.0 - General Availability
releasefeature

Flameup API v1.0.0 - General Availability

We're excited to announce the general availability of the Flameup API!

People API

  • Create, read, update, and delete user profiles
  • Upsert operations for seamless create-or-update workflows
  • Batch operations supporting up to 100 people per request
  • Search and filter by email, external_id, status, and custom attributes
  • Statistics endpoint for aggregate metrics

Events API

  • Track user events with custom properties
  • Query events by user, event name, and time range
  • Events stored in ClickHouse for high-performance analytics

Devices API

  • Register device tokens for iOS and Android push (Web coming soon)
  • Automatic token lifecycle management
  • Support for device metadata (model, OS version, app version)

Campaigns

  • Event-triggered campaigns
  • Webhook-triggered campaigns (API-initiated)
  • Scheduled campaigns with cron expressions
  • Dynamic schedule campaigns based on user attributes
  • Template personalization with Handlebars syntax

Transactional Messaging

  • Send one-off push notifications via API
  • Support for template IDs with variable substitution
  • Platform targeting (iOS and Android; Web coming soon)

Authentication

  • API key authentication via Authorization: Bearer header
  • Granular permissions system
  • IP whitelisting support
  • Key expiration and rotation

Developer Experience

  • Comprehensive API documentation
  • OpenAPI 3.0 specification
  • Code examples in JavaScript, Python, Swift, and Kotlin
  • Rate limiting with informative headers

Coming Soon

We're working on these features for upcoming releases:

Email Channel

Send transactional and campaign emails through Flameup:

  • Email templates with rich HTML support
  • Delivery tracking and analytics
  • Bounce and complaint handling

Webhooks

Receive real-time notifications for events in your workspace:

  • Campaign delivery events
  • User profile changes
  • Push delivery status

Segments API

Create and manage audience segments programmatically:

  • Define segment criteria via API
  • Dynamic segment membership
  • Use segments in campaign targeting

Analytics API

Query analytics data programmatically:

  • Campaign performance metrics
  • User engagement analytics
  • Event aggregations

API Versioning

The Flameup API uses URL versioning. The current version is v1.

https://api.flameup.ai/api/v1/...

When we release breaking changes, we'll introduce a new API version (e.g., v2) while maintaining support for previous versions during a deprecation period.

Version Support Policy:

  • New versions are announced at least 6 months before deprecation of old versions
  • Deprecated versions continue to work for at least 12 months after announcement
  • Security fixes are backported to supported versions

Feedback

Have feedback or feature requests? We'd love to hear from you:

  • Documentation Issues: Let us know if anything is unclear
  • API Feedback: Share your integration experience
  • Feature Requests: Tell us what you'd like to see next

Contact us at support@flameup.ai.

Was this page helpful?
Built with Documentation.AI

Last updated today