Derdack SIGNL4 (Preview)

Derdack SIGNL4 (Preview)

Derdack SIGNL4 is a mobile notification app to reliably notify operations teams on duty and boost their productivity.

The SIGNL4 connector allows you to

  • Send persistent mobile alerts notifications with automated escalations
  • Track delivery and confirmations
  • Route alerts to the right people by considering timely availability of team members (e.g. on-call duty, shifts)
  • Gain transparency on alert ownership and response

Use the SIGNL4 connector to send alerts on any triggers or from any 3rd system. It also allows you to extend existing SIGNL4 uses cases. For example, you can punch a user in or out of duty based on calendars in Microsoft Office 365, Microsoft StaffHub, Google Calendars and more. Another scenario is the extraction of shift performance metrics (e.g. alert response, on duty times) from SIGNL4 into a custom audit trail, such as a simple csv file, on a regular basis.

When you create a connection to SIGNL4, simply login with your SIGNL4 user credentials (or any other supported account such as your Microsoft work or school account) and give your consent on requested permissions. You will afterwards be able to invoke all actions of the API on your SIGNL4 team scope. This means that you can e.g. punch in other people in your team for on-call duty but no one from other SIGNL4 teams.

More information on the product and the API be found online at https://www.signl4.com/.

Actions

Confirm all

This method confirms all unhandled alerts your team currently has.

Get Alert Report

Returns information about the occurred alert volume in different time periods as well as information about the response behavior (amount of confirmed and unhandled alerts) of your team members.

Returns

An object holding information about the occurred alert volume in different time periods
AlertReport

An object holding information about the occurred alert volume in different time periods as well as information about the response behaviour (amount of confirmed and unhandled alerts) of your team members.

Get all Users

Returns a list of user objects with details such as their email address. Only users who are part of your team will be returned.

Returns

Get user by id

Returns a user's details such as name, email address, etc.

Required Parameters

User Id
string
Identifier of the user to get. Use 'Me' to get information about the currently logged in user. Can also be an email address of a user in the team or the unique id of an according user object.

Returns

Body
UserInfo

Basic information about a user.

Punch user in

Using this operation, the specified user will be punched in to duty.

Required Parameters

User Id
string
Identifier of the user to punch in. Use 'Me' to get information about the currently logged in user. Can also be an email address of a user in the team or the unique id of an according user object.

Returns

Body
UserDutyInfo

Information about a user's duty status.

Punch user out

Using this operation, the specified user will be punched out from duty.

Required Parameters

User Id
string
Identifier of the user to punch out. Use 'Me' to get information about the currently logged in user. Can also be an email address of a user in the team or the unique id of an according user object.

Returns

Body
UserDutyInfo

Information about a user's duty status.

Trigger Alert

Triggers a new alert for your team. All team members on duty will receive alert notifications.

Required Parameters

Attachment name
string
Name of this attachment, e.g. an original image file name.
Attachment MIME type
string
MIME content type of this attachment such as image/jpg (with encoding 1) or text/plain (e.g. with encoding 0).
Attachment data
string
Data of this attachment, such as a Base64 string representing a jpg image.
Parameter name
string
Name of this parameter, e.g. temperature.
Parameter value
string
The value of the parameter, e.g. 56F.
Alert title
string
Title or subject of this alert, e.g. 'Temperature alert'.
Alert details
string
Textual alert details, e.g. 'Temperature decreased by 10F within the last 4 minutes'.

Optional Parameters

External id
string
A unique id in your system for referencing this alert. You may use this field to match alerts that you have triggered with that id, e.g. when querying for an updated status of the alert later on.
Alert category
string
Name of a system or device category in your SIGNL4 team to which this alert should belong.
Unique id of this attachment in SIGNL4
string
Unique id of this attachment in SIGNL4.
Attachment encoding
integer
Indicates if the content is Base64 encoded (1) or not (0).
Parameter type
integer
Type of this parameter. This field is reserved for later use and should always match 0 when setting it.

Returns

Body
AlertInfo

Definitions

UserInfo

Basic information about a user.

Email
string
The user's mail address.
Name
string
Name of the user.
Subscription Id
string
ID of the subscription the user belongs to.
User Id
string
ID of the user.

AlertInfo

A collection of annotations users have left on this alert
array of object
A collection of annotations users have left on this alert.
A collection of of key/value pairs with additional device or system parameters that belong to this alert
array of object
A collection of of key/value pairs with additional device or system parameters that belong to this alert.
Alert id
string
Unique id of the alert in SIGNL4.
Alert severity
integer
Severity of this alert in SIGNL4. This field is reserved for later use.
Alert status
integer
Status of the alert in SIGNL4. 1 represents an unhandled alert while 2 represents a confirmed alert. All other values are reserved for later use and should never be a value of an instance of this object.
Alter title
string
Title or subject of this alert.
Annotation type
integer
Type of this annotation. This field is reserved for later use.
Attachment content
string
The content of this attachment.
Attachment name
string
Name of this attachment, e.g. an original image file name.
Category id
string
Unique id of a system or device category in your SIGNL4 team to which this alert belongs.
Collection of attachmanets such as images that belong to this alert
array of object
Collection of attachmanets such as images that belong to this alert.
External id
string
A unique id in your system for referencing this alert. You may use this field to match alerts that you have triggered with that id, e.g. when querying for an updated status of the alert later on.
Indicates if the content is Base64 or encoded (1) or not (0)
integer
Indicates if the content is Base64 or encoded (1) or not (0).
MIME content type
string
MIME content type of this attachment such as image/jpg.
Name of the team member who has closed the alert
string
Name of the team member who has closed the alert.
Name of the team member who has confirmed the alert
string
Name of the team member who has confirmed the alert.
Parameter name
string
Name of this parameter, e.g. temperature.
Parameter type
integer
Type of this parameter. This field is reserved for later use and should always match 0 when setting it.
Parameter value
string
The value of the parameter, e.g. 56F.
Subscription id
string
Unique id of your SIGNL4 subscription.
System or device category
string
Name of a system or device category in your SIGNL4 team to which this alert belongs.
Team id
string
Unique id of your SIGNL4 team.
Textual alert details
string
Textual alert details.
Time at which this alert was closed
date-time
Time at which this alert was closed.
Time at which this alert was confirmed
date-time
Time at which this alert was confirmed.
Time at which this alert was created in SIGNL4
date-time
Time at which this alert was created in SIGNL4.
Time at which this alert was last modified in SIGNL4
date-time
Time at which this alert was last modified in SIGNL4.
Type of the API or source through which this alert was triggered for your SIGNL4 team
integer
Type of the API or source through which this alert was triggered for your SIGNL4 team.
Unique id of the API or source through which this alert was triggered for your SIGNL4 team
string
Unique id of the API or source through which this alert was triggered for your SIGNL4 team.
Unique id of the SIGNL4 user who has left the annotation
string
Unique id of the SIGNL4 user who has left the annotation.
Unique id of this attachments in SIGNL4
string
Unique id of this attachments in SIGNL4.
User annotation
string
The annotation that was left by a user.

AlertReport

An object holding information about the occurred alert volume in different time periods as well as information about the response behaviour (amount of confirmed and unhandled alerts) of your team members.

Amount of alerts that occurred in the current duty period and your team has confirmed within that time
integer
Amount of alerts that occurred in the current duty period and your team has confirmed within that time.
Amount of alerts that occurred in the current duty period and your team has not confirmed within that time
integer
Amount of alerts that occurred in the current duty period and your team has not confirmed within that time.
Amount of alerts that occurred in the last 24h and your team has confirmed within that time
integer
Amount of alerts that occurred in the last 24h and your team has confirmed within that time.
Amount of alerts that occurred in the last 24h and your team has not confirmed within that time
integer
Amount of alerts that occurred in the last 24h and your team has not confirmed within that time.
Amount of alerts that occurred in the previous duty period and your team has confirmed within that time
integer
Amount of alerts that occurred in the previous duty period and your team has confirmed within that time.
Amount of alerts that occurred in the previous duty period and your team has not confirmed within that time
integer
Amount of alerts that occurred in the previous duty period and your team has not confirmed within that time.
Amount of alerts that occurred since the users duty status changed last time and she has confirmed within that time
integer
Amount of alerts that occurred since the users duty status changed last time and she has confirmed within that time.
Amount of alerts that occurred since the users duty status changed last time and she has not confirmed within that time
integer
Amount of alerts that occurred since the users duty status changed last time and she has not confirmed within that time.
Last time this metric changed
date-time
Last time this metric changed.
Last time this metric changed
date-time
Last time this metric changed.
Last time this metric changed
date-time
Last time this metric changed.
Time at which this duty period has ended or will end
date-time
Time at which this duty period has ended or will end.
Time at which this duty period has ended or will end
date-time
Time at which this duty period has ended or will end.
Time at which this duty period has started or will start
date-time
Time at which this duty period has started or will start.
Time at which this duty period has started or will start
date-time
Time at which this duty period has started or will start.
Time at which this period has ended or will end
date-time
Time at which this period has ended or will end.
Time at which this period has started or will start
date-time
Time at which this period has started or will start.
Time at which this time period has ended or will end
date-time
Time at which this time period has ended or will end.
Time at which this time period has started or will start
date-time
Time at which this time period has started or will start.
Unique id of the SIGNL4 team for which this alert report was created/requested. Will be empty if your team has switched off the SIGNL4 duty assistant
string
Unique id of the SIGNL4 team for which this alert report was created/requested. Will be empty if your team has switched off the SIGNL4 duty assistant.
Unique id of the SIGNL4 user for which this alert report was created/requested. Will be empty if your team has switched on the SIGNL4 duty assistant
string
Unique id of the SIGNL4 user for which this alert report was created/requested. Will be empty if your team has switched on the SIGNL4 duty assistant.
Unique id of your SIGNL4 subscription
string
Unique id of your SIGNL4 subscription.
lastModified
date-time
An object holding information about the occurred alert volume in different time periods as well as information about the response behaviour (amount of confirmed and unhandled alerts) of your team members.

UserDutyInfo

Information about a user's duty status.

On Duty
boolean
True if the user is on duty.
Overdue
boolean
True if the user is currently overdue, e.g. because nobody else has replaced that user in time.
Punch In Date-Time
date-time
The date-time in UTC format. ex. yyyy-MM-ddTHH:mm:ss.fffZ (UTC format)

GetAllUsers_Response

Items
UserInfo
Basic information about a user.

Limits

NameCallsRenewal Period
API calls per connection10060 seconds