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…
Communication#openapi#messaging
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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
Endpoints 101
Alerts
- POSTTrigger Alert
/alertsTriggers a new alert for your team. All team members on duty will receive alert notifications. - POSTConfirms all visible alerts
/alerts/acknowledgeAll?userId=stringThis method confirms all unhandled alerts your team currently has by a specific user. - POSTAcknowlegde multiple alerts
/alerts/acknowledgeMultipleThis method confirms all alerts provided. - POSTClose all acknowledged alerts.
/alerts/closeAll?userId=stringThis method closes all acknowledged alerts your team currently has. - POSTClose multiple alerts
/alerts/closeMultipleThis method closes all alerts provided. - POSTGets alerts paged
/alerts/paged?maxResults=0&userId=string - GETGet Alert Report
/alerts/report?userId=stringReturns information about the occurred alert volume in different time periods as well as information about the response behaviour (amount of confirmed and… - POSTQueue undo of multiple acknowledgments.
/alerts/undoAcknowledgeMultipleThis method tries to undo the acknowledgement of multiple alerts via a queue. The operation is handled in the background. - POSTWithdraw closure of multiple alerts
/alerts/undoCloseMultipleThis method tries to undo multiple alert closes. The operation is handled in the background. - GETGet Alert
/alerts/:alertIdGets an alert by id. - POSTAcknowledge an alert
/alerts/:alertId/acknowledge - POSTAnnotate Alert
/alerts/:alertId/annotateAnnotates an alert by given Annotation Info. - GETGet annotations of an alert
/alerts/:alertId/annotationsGet annotations of an alert by id. - GETGet attachments of an alert
/alerts/:alertId/attachmentsGet attachments of an alert by id. - GETGets a specified attachment of a specified alert.
/alerts/:alertId/attachments/:attachmentId?width=0&height=0&scale=true - POSTClose an alert
/alerts/:alertId/close - GETGet alert notifications
/alerts/:alertId/notificationsGet notifications of all users by alert id. - GETGet an overview alert.
/alerts/:alertId/overviewGet overview alert by id. - POSTUndo the acknowledgement of an alert.
/alerts/:alertId/undoAcknowledgeThis method tries to undo an alert acknowledgement. - POSTUndo the closure of an alert.
/alerts/:alertId/undoCloseThis method tries to undo an alert close.
Categories
- GETGets the names of all alert category images.
You can get the image by going to account.signl4.com/images/alerts/categoryImageName.svg
/categories/images - GETGet all categories
/categories/:teamIdSample Request: GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7 - POSTCreate a new category
/categories/:teamIdSample Request: POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7 { "name": "Water", "imageName": "water.svg", "color": "#0000cc", "keywordMatching":… - GETGet metrics for all categories
/categories/:teamId/metricsSample Request: GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/metrics - GETGet a specific category
/categories/:teamId/:categoryIdSample Request: GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e - PUTUpdate an existing category
/categories/:teamId/:categoryIdSample Request: PUT /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e { "name": "Water-Updated", "imageName": "water.svg",… - DELETEDelete an existing category
/categories/:teamId/:categoryIdSample Request: DELETE /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e - GETGet metrics for a specific category
/categories/:teamId/:categoryId/metricsSample Request: GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/metrics - GETGet category subscriptions
/categories/:teamId/:categoryId/subscriptionsSample Request: GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions { } - POSTSet category subscriptions
/categories/:teamId/:categoryId/subscriptionsSample Request: POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions { }
Duties
- GETGet Information about downloadable reports
/teams/:teamId/dutyReports - GETDownload duty report with a specific fileName
/teams/:teamId/dutyReports/:fileName - GETGet duty assistant info for a team
/teams/:teamId/dutysummary?lastTwoDuties=true - GETReturns information about all duties that belong to the team.
/teams/:teamId/schedules?UserId=string&MinDate=2024-01-01T00:00:00Z&Limit=0 - POSTCreate/Update given duty schedule.
/teams/:teamId/schedules - POSTDelete duty schedules in range
/teams/:teamId/schedules/deleteRange - POSTSave multiple schedules. It is possible to override existing schedules if you wish
/teams/:teamId/schedules/multiple?overrideExisting=true - DELETEDelete a specific duty.
/teams/:teamId/schedules/:dutyId - GETReturns information of the duty schedule with the specified Id.
/teams/:teamId/schedules/:scheduleId
Events
- POSTGet overview event paged.
/events/paged?maxResults=0Get overview event paged. If there are more results, you also get a continuation token which you can add to the event filter. - GETGet overview event
/events/:eventId/overviewGet overview event by id. - GETGet event parameters
/events/:eventId/parametersGet parameters of an event by id.
Prepaid
- GETGet your subscription's current prepaid balance.
/prepaid/balance - GETGet your subscription's current prepaid settings.
/prepaid/settings - PUTUpdate your subscription's current prepaid settings.
/prepaid/settings - GETGet your subscription's prepaid transactions.
/prepaid/transactions - GETGet a subscription's current prepaid balance.
/subscriptions/:subscriptionId/prepaidBalance - GETGet a subscription's current prepaid settings.
/subscriptions/:subscriptionId/prepaidSettings - PUTUpdate a subscription's current prepaid settings.
/subscriptions/:subscriptionId/prepaidSettings - GETGet a subscription's prepaid transactions.
/subscriptions/:subscriptionId/prepaidTransactions
Scripts
- GETReturns all script instances of the SIGNL4 team
/scripts/instances?teamId=stringReturns all script instances in the subscription. - POSTCreates a new script instance in the in the SIGNL4 team.
/scripts/instancesCreates a new script instance of the script specified in the request body. - GETReturns all information about a given script instance which includes its runtime status.
/scripts/instances/:instanceIdGets the script instance specified by the passed instance id. - PUTUpdates a given script instance, typically used for updating the configuration of a script.
/scripts/instances/:instanceIdUpdates the specified script instance. - DELETEDeletes a script instance.
/scripts/instances/:instanceIdGets the script instance specified by the passed instance id. - PUTUpdates custom data of a given script instance which includes its display name.
/scripts/instances/:instanceId/dataUpdates the specified script instance. - POSTDisables a given script instance.
/scripts/instances/:instanceId/disable - POSTEnables a script instance.
/scripts/instances/:instanceId/enable - GETReturns all available inventory scripts which can be added to a SIGNL4 subscription.
/scripts/inventoryReturns all available inventory scripts which can be added to a SIGNL4 subscription. - GETReturns all inventory scripts.
/scripts/inventory/parsed?language=string - GETReturns an inventory script by its id.
/scripts/inventory/parsed/:scriptId?language=stringGets the script specified by the passed script id.
Subscriptions
- GETGet infos of all available/managed subscriptions.
/subscriptions - GETGet infos of a specific subscription.
/subscriptions/:subscriptionId - GETReturns the subscription's channel price information.
/subscriptions/:subscriptionId/channelPrices - GETReturns the features of a specified subscription.
/subscriptions/:subscriptionId/features - PUTUpdates a subscriptions profile.
/subscriptions/:subscriptionId/profile - GETGets a subscription's user licenses.
/subscriptions/:subscriptionId/userLicenses
Teams
- GETGet infos for all teams of the subscription.
/subscriptions/:subscriptionId/teams - GETGet infos of all teams.
/teams - GETGets infos of a specific team.
/teams/:teamId - GETGet information about downloadable alert reports
/teams/:teamId/alertReports - GETReturns Alert Report
/teams/:teamId/alertReports/:fileName - GETGets alert settings of a specific team.
/teams/:teamId/alertSettings - POSTSets alert settings of a specific team.
/teams/:teamId/alertSettings - GETGets event sources of a specific team.
/teams/:teamId/eventSources - PUTUpdates team profile of a team
/teams/:teamId/profile - GETGets setup progress of a specific team.
/teams/:teamId/setupProgress
Users
- GETGet all Users
/usersReturns a list of user objects with details such as their email address and duty information. Only users who are part of your team will be returned. - GETGet User by Id
/users/:userIdReturns a user object with details such as his email address and duty information. - PUTUpdates the password of a user
/users/:userId/changePassword - POSTChecks if a user has the provided permission.
/users/:userId/checkPermissions?teamId=string - GETGet duty status by user Id
/users/:userId/dutyStatusReturns a object with duty information. - GETGET /users/{userId}/image
/users/:userId/image?height=0&width=0 - POSTUploaded a profile image for a specified user.
/users/:userId/image - PUTUpdates user profile of an user
/users/:userId/profile - POSTPunch User in
/users/:userId/punchInThe specified user will be punched in to duty. - POSTPunch User in as Manager
/users/:userId/punchInAsManagerThe specified user will be punched in to duty as a manager. - POSTPunch User out
/users/:userId/punchOutThe specified user will be punched out from duty. - GETGets setup progress of a specific user.
/users/:userId/setupProgress
Webhooks
- GETGet Webhooks
/webhooks?teamId=stringReturns a collection of defined outbound webhooks in the system. - POSTCreate Webhook
/webhooksCreates a new outbound webhook that will be notified when certain events occur. - GETGet Webhook by Id
/webhooks/:webhookIdReturns information of the webhook specified by the passed id. - PUTUpdate Webhook by Id
/webhooks/:webhookIdUpdates the specified webhook. - DELETEDelete Webhook by Id
/webhooks/:webhookIdDeletes the specified webhook so that it will no longer be notified. - POSTAbility to enable a webHook.
/webhooks/:webhookId/disable - POSTAbility to disable a webHook.
/webhooks/:webhookId/enable
TeamsMemberships
- GETGet all invites of a team.
/teams/:teamId/memberships - POSTInvite users to a team
/teams/:teamId/memberships - POSTSends invite email again if an invite exists
/teams/:teamId/memberships/resendInviteMail - PUTUpdate user's team membership.
/teams/:teamId/memberships/:userId?requesterUserId=stringUpdates the user's team membership. You can move the user to another team within the subscription and/or change the user's role. - DELETERemoves a user or invitation from a team, and may delete the user if he is not in any team.
/teams/:teamId/memberships/:userId?requesterUserId=string
API details
- Base URL
https://connect.signl4.com/api- Authentication
- OAuth 2.0 (authorization code flow) with 3 scopes
- Operations
- 101 operations on 84 pathsGET 52POST 33PUT 11DELETE 5
- Main resources
- Alerts 20Users 12Scripts 11Categories 10Teams 10Duties 9Prepaid 8Webhooks 7Subscriptions 6TeamsMemberships 5
- Response formats
application/jsontext/jsontext/plain- Description format
- OpenAPI 3.0.1, API version
v1 - Links
- OpenAPI document · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the SIGNL4 API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the SIGNL4 API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 3 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Trigger Alert” (POST /alerts), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the 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… It is listed under Communication and has 101 endpoints.
Who publishes the SIGNL4 API?
It is listed from Signl4's public API description (an OpenAPI document), not published by Signl4 on Swastik Codes. Anyone who controls signl4.com can claim the profile by adding a DNS TXT record.
What is the base URL of the SIGNL4 API?
Requests go to https://connect.signl4.com/api. Endpoint paths are added to this base URL.
How do I authenticate with the SIGNL4 API?
With OAuth 2.0 (authorization code flow) with 3 scopes.
How many endpoints does the SIGNL4 API have?
101 operations on 84 paths (52 GET, 33 POST, 11 PUT, 5 DELETE). The largest groups are Alerts, Users, Scripts, Categories.
Is forking the SIGNL4 API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.