Beacon Integration Guide

Learn how to integrate your beacons into external applications, websites, and services using our flexible API options.

Direct URL Integration

The simplest way to integrate a beacon is by linking directly to its public URL. This works for any beacon and doesn't require authentication.

How it works:

  • Every beacon has a unique public URL
  • Anyone can view the current status by visiting the URL
  • Perfect for sharing status in emails, chat, or documentation

Example URL:

https://getbeacons.app/b/28359ed0-b52e-4517-a175-1a05db71dca1

Replace the UUID with your beacon's unique identifier

Use cases:

  • Status pages and dashboards
  • Team communication channels
  • Documentation and wikis
  • Email signatures

Best Practices

Rate Limiting

  • API requests are rate-limited to prevent abuse
  • For high-frequency monitoring, consider caching responses
  • RSS feeds update automatically - no need to poll frequently

Error Handling

  • Always implement proper error handling in your integrations
  • Beacon URLs return 404 if the beacon doesn't exist or is private
  • JSON API returns 403 if subscription is required but not active

Security

  • Beacon URLs are public - don't include sensitive information
  • Use HTTPS for all API requests
  • Consider implementing your own authentication layer for sensitive integrations

Need Help?

Having trouble with your integration? We're here to help!

  • Documentation: Check our API reference for detailed specifications
  • Examples: Browse our GitHub repository for integration examples
  • Support: Contact our support team for personalized assistance