SIGNL4 API

Use our API for systems integration or to build your own use cases. Sample scenarios include but are not limited to:

  • 2-way integration: Triggering of Signls and updates in the third party systems when alert state changes occur
  • Retrieving alarms for logging purposes
  • Calendar integrations: Creation and management of on-call duties
  • Punch users in and out based on external calendars
  • etc.

AUTHENTICATION
Using the API requires an API key, which you can generate in the SIGNL4 portal under 'Developers'.
This key must then be specified in a special header in every HTTP request.
This header is called X-S4-Api-Key.

The base URL of the API is https://connect.signl4.com/api/.
Copyright © Derdack GmbH

Claim this API

Are you the operator of SIGNL4 API? Submit a claim to establish contact with us.

Report an Issue

Found something wrong with SIGNL4 API? Let us know about broken links, changed auth, deprecated endpoints, or other issues.

Screenshot:
Screenshot of SIGNL4 API homepage
Base URL: https://connect.signl4.com/api
Auth: unknown
Endpoints: 17
Reachable: unknown
CORS: unknown

Links

Homepage: https://www.signl4.com/feedback-we-love-hear-from-you/
API Base: https://connect.signl4.com/api

Topics

MESSAGING, MONITORING

Endpoints

Method Path Summary Auth Last Status Latency
GET alerts/report Get Alert Report
GET alerts/{alertId} Get Alert
GET alerts/{alertId}/annotations Get annotations of an alert
GET alerts/{alertId}/attachments Get attachments of an alert
GET alerts/{alertId}/attachments/{attachmentId} Gets a specified attachment of a specified alert.
GET alerts/{alertId}/overview Get an overview alert.
GET categories/images Gets the names of all alert category images. You can get the image by going to account.signl4.com/images/alerts/categoryImageName.svg
GET categories/{teamId} Get all categories
GET categories/{teamId}/metrics Get metrics for all categories
GET categories/{teamId}/{categoryId} Get a specific category
GET categories/{teamId}/{categoryId}/metrics Get metrics for a specific category
GET events/{eventId}/overview Get overview event
GET events/{eventId}/parameters Get event parameters
GET prepaid/balance Get your subscription's current prepaid balance.
GET prepaid/transactions Get your subscription's prepaid transactions.
GET scripts/instances Returns all script instances of the SIGNL4 team
GET scripts/instances/{instanceId} Returns all information about a given script instance which includes its runtime status.
GET scripts/inventory Returns all available inventory scripts which can be added to a SIGNL4 subscription.
GET scripts/inventory/parsed Returns all inventory scripts.
GET scripts/inventory/parsed/{scriptId} Returns an inventory script by its id.