When every second counts—whether it’s a security incident, power failure, or urgent announcement—you need a way to take over your screens instantly and reliably. CastHub’s Emergency Alert API gives your organization just that: a secure, flexible way to trigger high-priority alerts on digital signage, across any number of devices or locations.

What Is the Emergency API?

The Emergency API is part of CastHub’s developer tools that allows you to:

• Start or stop alerts on individual device groups, all screens, or specific group names
• Integrate emergency signage triggers into other tools or automated systems you already use (e.g., incident response platforms, security systems, etc.)

It’s fast, secure, and optimized for real-time execution.

How It Works: Key Endpoints

All API calls require:

• userEmail — the email linked to your CastHub account
• integrationKey — a secure token you generate in your dashboard
  Base URL: https://casthub-webapi.azurewebsites.net

Here are the most commonly used endpoints:

How to Find Your Device Group IDs

To use certain API endpoints, you’ll need the numeric ID of the device group you want to control. Here’s how to get that:

1. Send a GET request to: GET /api/v1/alerts/device-groups Example full URL:
   https://casthub-webapi.azurewebsites.net/api/v1/alerts/device-groups

Start Alert for a Device Group (by ID)

PATCH /api/v1/alerts/device-groups/{deviceGroupId}/start-alert

Example: Start an alert for screens in the lobby (deviceGroupId = 101)

Stop Alert for a Device Group (by ID)

PATCH /api/v1/alerts/device-groups/{deviceGroupId}/stop-alert

Start Alert by Group Name

PATCH /api/v1/alerts/device-groups/start-alert-by-group-name?deviceGroupName=LobbyScreens

Stop Alert by Group Name

PATCH /api/v1/alerts/device-groups/stop-alert-by-group-name?deviceGroupName=LobbyScreens

Start Alert on All Screens

PATCH /api/v1/alerts/device-groups/start-alert

Stop Alert on All Screens

PATCH /api/v1/alerts/device-groups/stop-alert

Built with Security in Mind

• You control your API key—rotate it any time
• No stored full tokens, no third-party access
• Access is role-based and authenticated

Use Cases Across Industries

• Education: Trigger lockdown or weather alerts campus-wide from your command center
• Healthcare: Display emergency codes or evacuations hospital-wide
• Corporate & Warehousing: Broadcast hazard notifications or internal system failures
• Retail: Auto-display operational alerts like outages or urgent updates

How to Generate Your Integration Key

To ensure secure API usage, CastHub uses a private integration key per account. Here’s how to set it up:

1. Log in to your CastHub admin dashboard.
2. Navigate to Settings → Integrations.
3. Click “Generate Integration Key.”
4. Copy the key immediately — for security, it won’t be shown again.
5. Use this key in your API request headers as integrationKey.
6. Required Headers
   • For every request you make, include the following headers:
     • userEmail : Your account’s user email address.
     • integrationKey : The integration key you generated (and set) previously.

You can reset your key at any time, which will deactivate the previous one

Want to Get Started?

1. Log in to your CastHub dashboard and generate your integration key
2. Assign and label your device groups
3. Integrate with your systems using the endpoints above

Need a walkthrough or help with integration? Contact us here or reach out to your CastHub support rep.