Documentation

Appearance

Operations integrations ​

Integrations extend an operational workflow. Use the integration settings and credential scopes available to your organisation, and build external API integrations against the published Gateway API.

Hologram cellular data ​

Where the Hologram module is enabled, an organisation can store protected API credentials, synchronise SIM inventory, match ICCIDs to devices, review usage, and configure high-usage or assignment alerts.

  1. Create a dedicated Hologram credential with only required access.
  2. Connect it in the organisation integration settings.
  3. Review matched, unassigned, and ambiguous SIMs.
  4. Confirm usage units and synchronisation freshness.
  5. Set a threshold against observed normal use.
  6. Test alert routing before relying on it.

ICCID matching can fail when device identity is missing, duplicated, or reformatted. Resolve ambiguity rather than choosing a device by name alone. Disconnecting the integration stops future synchronisation but does not rewrite historical device records.

Microsoft Sentinel ​

Where the Sentinel integration is enabled, security activity can be exported to the configured workspace. Use a dedicated credential, validate field mapping with a test event, and monitor delivery, retry, and flush status.

An export is not proof of ingestion into a detection rule. Confirm the event in Sentinel, its timestamp and organisation context, then test the downstream rule and retention policy. Rotate credentials after exposure and keep a documented failover path for security review.

Webhooks and callbacks ​

Scheduled HTTP jobs, log alert rules, and supported incident workflows can call external endpoints. Give each integration its own secret, make receivers idempotent, validate signatures or shared credentials, and handle retries without duplicating work.

Completion callbacks report long-running scheduled work. Heartbeats prove that a job has reached its success point. They are related controls but have different endpoints and state.

Gateway API ​

Use the Gateway API reference for external inventory and supported remote operations. Create a purpose-specific organisation API key and treat pagination, errors, and rate behaviour as part of the integration contract.

Build external API integrations with endpoints published in the Gateway API reference.