View Categories

CastHub Integration Key for API Access

The CastHub integration key

The integration key is the credential customers use to connect CastHub to their own systems or third-party tools. It is separate from your sign-in credentials, so you can grant or revoke programmatic access without affecting normal user accounts.

Generate a key

Open your profile area in the CastHub web or mobile app. Choose Generate Integration Key. Copy the key immediately and store it securely; for security reasons, the full key is shown only once at the moment of generation.

Use a key

Pass the integration key as a credential when calling the CastHub API. Treat it like a password: do not commit it to source control, do not share it in messages, and do not embed it in client-side code where end users could read it.

Rotate a key

From the same profile area, choose Rotate Integration Key. The previous key is invalidated immediately. Update any system that relied on the previous key with the new one. Rotate keys on a regular cadence (quarterly is typical) and immediately if you suspect a key has been exposed.

Common uses

Pushing menu or pricing updates from a POS or back-office system into a CastHub presentation on a schedule. Triggering an alert from an existing alarm, paging, or incident-response platform. Including CastHub status (devices online, current presentation, recent commands) in an internal operations dashboard.

What the integration key cannot do

The integration key does not change billing or subscription settings. Those actions remain tied to user sign-in for security.

Scroll to Top