SIGNL4 - Mobile Alerting (Preview)

  • Reference

SIGNL4 offers critical mobile alerting, incident response and service dispatching for operating critical infrastructure. It alerts you persistently via app push, SMS text and voice calls including tracking, escalation, collaboration and duty planning.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Derdack GmbH
URL https://www.signl4.com/feedback-we-love-hear-from-you/
Email success@signl4.com
Connector Metadata
Publisher Derdack
Website https://www.signl4.com
Privacy policy https://www.signl4.com/privacy-policy/
Categories IT Operations; Communication

SIGNL4 offers critical alerting, incident response and service dispatching for operating critical infrastructure. It alerts you persistently via app push, SMS text and voice calls including tracking, escalation, collaboration and duty planning.

You can integrate SIGNL4 into your flow in order to send reliable team alerts whenever needed.

Prerequisites

You need an SIGNL4 account. If you no not already have one you can get one at https://connect.signl4.com/. You can also directly download the mobile app from the Google Play Store or from the Apple App Store.

How to get credentials

In order to use the connector you need your SIGNL4 API key. In the SIGNL4 web portal you get your API key under Integrations -> API Key. You can then use your API key to authenticate your SIGNL4 connector in Power Automate.

Get started with your connector

You can find a detailed description of the the SIGNL4 API functions here. After adding the SIGNL4 connector to your Power Automate flow you need to obtain the SIGNL4 API key. Then you can use the API functions accordingly. If you should have any further questions please do not hesitate to contact the SIGNL4 team.

The easiest way to start is to use the EventsSend action to send an alert:

  • First get Your SIGNL4 team secret / integration secret from your SIGNL4 web portal.
  • When you have the team secret / integration secret you can use this one in the function EventsSend to trigger an event that can generate an alert for your team. You just need to enter any Title and Message. You can find a description of the other parameters on the inbound webhook documentation page.
  • That's it and you now trigger an event and receive an alert in SIGNL4.

Known issues and limitations

The SIGNL4 connector for Power Automate encapsulates the whole SIGNL4 REST API 2.0. Some functionalities depend on your SIGNL4 plan.

Common errors and remedies

N/A

FAQ

You can find the SIGNL4 FAQ and online help here. Also there is a comprehensive video library available.

Creating a connection

The connector supports the following authentication types:
Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key securestring The API Key for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Ability to disable a webHook

Ability to disable a webHook.
Ability to enable a webHook

Ability to enable a webHook.
Acknowledge an alert

Acknowledge an alert.
Acknowlegde multiple alerts

This method confirms all alerts provided.
Add user to a team

Add user to a team.
Annotate Alert

Annotates an alert by given Annotation Info.
Checks if a user has the provided permission

Checks if a user has the provided permission.
Close all acknowledged alerts

This method closes all acknowledged alerts your team currently has.
Close an alert

Close an alert.
Close multiple alerts

This method closes all alerts provided.
Confirms all visible alerts

This method confirms all unhandled alerts your team currently has by a specific user.
Copy holidays from one team to another

Copy holidays from one team to another.
Creat or Update given duty schedule

Create/Update given duty schedule.
Create a new alerting pattern

Create a new alerting pattern.
Create a new category

Sample Request:

POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7
{
    "name": "Water",
    "imageName": "water.svg",
    "color": "#0000cc",
    "keywordMatching": "Any",
    "keywords": [
        {
            "value": "H2O"
        },
        {
            "value": "Water"
        }
    ]
}
Create a new Remote Action

Sample Request:

POST /remoteActions
{
    "teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7",
    "name": "MyAction",
    "enabled": true,
}
Create a new Remote Job

Sample Request:

POST /remoteActions/{actionId}/jobs
{
    "remoteActionPin" : "1234",
    "parameters": [
        {
            "name": "Param1",
            "value": "Value 1"
        }
    ]
}
Create event source

Create event source.
Create new callout templates for your subscription

Create new callout templates for your subscription.
Create Webhook

Creates a new outbound webhook that will be notified when certain events occur.
Creates a new script instance in the in the SIGNL4 team

Creates a new script instance of the script specified in the request body.
Delete a contact address from a user

Delete a contact address from a user.
Delete a specific alerting pattern

Delete a specific alerting pattern.
Delete a specific duty

Delete a specific duty.
Delete an event distribution

Delete an event distribution.
Delete an event source

Delete an event source.
Delete an existing category

Sample Request:

DELETE /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e
Delete duty schedules in range

Delete duty schedules in range.
Delete existing callout template from your subscription

Delete existing callout template from your subscription.
Delete holidays

Delete holidays.
Delete personal user image

Delete personal user image.
Delete the phone number of a user

Delete the phone number of a user.
Delete Webhook by Id

Deletes the specified webhook so that it will no longer be notified.
Deletes a Remote Action

Sample Request:

DELETE /eaRemoteActions/{actionId}
Deletes a script instance

Gets the script instance specified by the passed instance id.
Deletes current team image

Deletes current team image.
Deletes user account

Deletes user account.
Disables a given script instance

Disables a given script instance.
Download duty report with a specific fileName

Download duty report with a specific fileName.
Enables a script instance

Enables a script instance.
Escalate an alert manually to a team

Escalate an alert manually to a team.
Get a specific category

Sample Request:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e
Get a subscription's current prepaid balance

Get a subscription's current prepaid balance.
Get a subscription's current prepaid settings

Get a subscription's current prepaid settings.
Get a subscription's prepaid transactions

Get a subscription's prepaid transactions.
Get Alert

Gets an alert by id.
Get alert notifications

Get notifications of all users by alert id.
Get Alert Report

Returns 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 the team members.
Get alert timeline entries

Get alert timeline entries of an alert by id.
Get all alerting patterns from team

Get all alerting patterns from team.
Get all callout templates for your subscription

Get all callout templates for your subscription.
Get all categories

Get all categories.
Get all categories

Sample Request:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7
Get all teams the user is member of

Returns a list of team objects with details such as their name. Only teams the user is member of will be returned.
Get all Users

Returns a list of user objects with details such as their email address and duty information. Only users you have access to will be returned.
Get attachment infos of an alert

Get attachments of an alert by id.
Get category subscriptions

Sample Request:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions
{
}
Get details about an alert

Get details about an alert.
Get details of an event

Get details of an event.
Get duty assistant info for teams

Get duty assistant info for teams.
Get duty status by user Id

Returns a object with duty information.
Get event parameters

Get parameters of an event by id.
Get event source by id

Get event source by id.
Get event sources from one or more teams

Get event sources from one or more teams.
Get holidays for team

Get holidays for team.
Get information about downloadable alert reports

Get information about downloadable alert reports.
Get infos for all teams of the subscription

Get infos for all teams of the subscription.
Get infos of a specific subscription

Get infos of a specific subscription.
Get infos of all available and managed subscriptions

Get infos of all available/managed subscriptions.
Get infos of all teams

Get infos of all teams.
Get metrics for a specific category

Sample Request:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/metrics
Get metrics for all categories

Sample Request:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/metrics
Get notification profiles for user

Get notification profiles for user.
Get overview event

Get overview event by id.
Get overview event paged

Get overview event paged. If there are more results, you also get a continuation token which you can add to the event filter.
Get personal user image

Get personal user image.
Get public information about all teams in a subscription

Get public information about all teams in a subscription.
Get team duty settings for multiple teams

Get team duty settings for multiple teams.
Get team memberships by team

Get team memberships by team.
Get Team memberships from a user

Get Team memberships from a user.
Get Team privacy settings for a team

Get Team privacy settings for a team.
Get User by Id

Returns a user object with details such as his email address and duty information.
Get Webhook by Id

Returns information of the webhook specified by the passed id.
Get Webhooks

Returns a collection of defined outbound webhooks in the system.
Get your subscription's current prepaid balance

Get your subscription's current prepaid balance.
Get your subscription's current prepaid settings

Get your subscription's current prepaid settings.
Get your subscription's prepaid transactions

Get your subscription's prepaid transactions.
Gets a specified attachment of a specified alert

Gets a specified attachment of a specified alert.
Gets a subscription's user licenses

Gets a subscription's user licenses.
Gets a subscription's voice number licenses

Gets a subscription's voice number licenses.
Gets alert settings of a specific team

Gets alert settings of a specific team.
Gets alert settings of a specific team

Gets alert settings of a specific team.
Gets alerts paged

Gets alerts paged.
Gets event sources of a specific team

Gets event sources of a specific team.
Gets image of a specified team

Gets image of a specified team.
Gets infos of a specific team

Gets infos of a specific team.
Gets setup progress of a specific team

Gets setup progress of a specific team.
Gets setup progress of a specific user

Gets setup progress of a specific user.
Gets the names of all alert category images

Gets the names of all alert category images. You can get the image by going to account.signl4.com/images/alerts/categoryImageName.svg.
Getting all users of specified teams

Getting all users of specified teams.
Invite users to a team

Invite users to a team.
Punch User in

The specified user will be punched in to duty.
Punch User in as Manager

The specified user will be punched in to duty as a manager.
Punch User out

The specified user will be punched out from duty.
Queue undo of multiple acknowledgments

This method tries to undo the acknowledgement of multiple alerts via a queue. The operation is handled in the background.
Removes a user or invitation from a team

Removes a user or invitation from a team.
Retrieve a definition

Retrieve a definition.
Retrieve all available definition

Retrieve all available definition.
Returns a Remote Action

Sample Request:

GET /RemoteActions/{actionId}
Returns a Remote Job from Journal

Sample Request:

GET /remoteActions/journal/{jobId}
Returns Alert Report

Returns Alert Report.
Returns all available inventory scripts

Returns all available inventory scripts which can be added to a SIGNL4 subscription.
Returns all information about a given script instance

Gets the script instance specified by the passed instance id.
Returns all inventory scripts

Returns all inventory scripts.
Returns all script instances of the SIGNL4 team

Returns all script instances in the subscription.
Returns an inventory script by its id

Gets the script specified by the passed script id.
Returns information about all planned schedules

Returns information about all planned schedules.
Returns information of the duty schedule with the specified Id

Returns information of the duty schedule with the specified Id.
Returns Remote Actions

Sample Request:

GET /RemoteActions?externalId=12345
Returns Remote Jobs paged from Journal

Sample Request:

POST /remoteActions/journal/paged?maxResults=100
{
    "statusCode": "Executed"
}
Returns the features of a specified subscription

Returns the features of a specified subscription.
Returns the subscription's channel price information

Returns the subscription's channel price information.
Save holidays for a team

Save holidays for a team.
Save multiple schedules

Save multiple schedules. It is possible to override existing schedules if you wish.
Save repeating holidays for a team

Save repeating holidays for a team.
Send event

Send event.
Sends a mail to a specified user

Sends a mail to a specified user that contains information of all event sources of the user's team.
Sends invite email again if an invite exists

Sends invite email again if an invite exists.
Set category subscriptions

Sample Request:

POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions
{
}
Set location of an user

Set location of an user.
Set notification profiles for user

Set notification profiles for user.
Set the phone number of a user

Set the phone number of a user. If another phone number is saved, it will be overwritten.
Sets alert settings of a specific team

Sets alert settings of a specific team.
Trigger Alert

Triggers a new alert for your team. All team members on duty will receive alert notifications.
Undo the acknowledgement of an alert

This method tries to undo an alert acknowledgement.
Undo the closure of an alert

This method tries to undo an alert close.
Update a subscription's current prepaid settings

Update a subscription's current prepaid settings.
Update an event source

Update an event source.
Update an existing alerting pattern

Update an existing alerting pattern.
Update an existing category

Sample Request:

PUT /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e
{
    "name": "Water-Updated",
    "imageName": "water.svg",
    "color": "#0000cc",
    "keywordMatching": "All",
    "keywords": [
        {
            "value": "H2O"
        },
        {
            "value": "Water"
        },
        {
            "value": "Wet"
        }
    ]
}
Update existing callout template for your subscription

Update existing callout template for your subscription.
Update locale info (e.g. language, time zone) for user

Update locale info (e.g. language, time zone) for user.
Update privacy settings for a team

Update privacy settings for a team.
Update user's team membership

Updates the user's team membership. You can move the user to another team within the subscription and/or change the user's role.
Update Webhook by Id

Updates the specified webhook.
Update your subscription's current prepaid settings

Update your subscription's current prepaid settings.
Updates a given script instance

Updates the specified script instance, typically used for updating the configuration of a script.
Updates a Remote Action

Sample Request:

PUT /remoteActions/{actionId}
{
    "teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7",
    "name": "MyAction",
    "enabled": true,
}
Updates a subscriptions profile

Updates a subscriptions profile.
Updates custom data of a given script instance which includes its display name

Updates the specified script instance.
Updates team profile of a team

Updates team profile of a team.
Updates the password of a user

Updates the password of a user.
Updates user profile of an user

Updates user profile of an user.
Uploaded a profile image for a specified team

Uploaded a profile image for a specified team.
Uploaded a profile image for a specified user

Uploaded a profile image for a specified user.
Validate a time slots of a pattern

Validate a time slots of a pattern against all existing time slots of other patterns.
Validates a previous created phone number for a user

Validates a previous created phone number for a user.
Withdraw closure of multiple alerts

This method tries to undo multiple alert closes. The operation is handled in the background.

Ability to disable a webHook

Operation ID:
WebhooksEnable

Ability to disable a webHook.

Parameters

Name Key Required Type Description
Webhook ID
 webhookId True string

Webhook ID for webhook which should be enabled.

Returns

Body
WebhookInfo

Ability to enable a webHook

Operation ID:
WebhooksDisable

Ability to enable a webHook.

Parameters

Name Key Required Type Description
Webhook ID
 webhookId True string

Webhook ID for webhook which should be disabled.

Returns

Body
WebhookInfo

Acknowledge an alert

Operation ID:
AlertsAcknowledge

Acknowledge an alert.

Parameters

Name Key Required Type Description
Alert ID
 alertId True string

Id to acknowledge an alert.
descr
 descr string
uid
 uid True string

Returns

Body
V2.AlertInfo

Acknowlegde multiple alerts

Operation ID:
AlertsAcknowledgeMultiple

This method confirms all alerts provided.

Parameters

Name Key Required Type Description
alertIds
 alertIds True array of string
descr
 descr string
uid
 uid True string

Add user to a team

Operation ID:
TeamsAddUser

Add user to a team.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

Id of team the user should be invited to.
User ID
 userId True string

Id of user you want to add to a team.
roleId
 roleId string
setUserOnDuty
 setUserOnDuty boolean

Returns

Body
V2.TeamMembershipDetails

Annotate Alert

Operation ID:
AlertsAnnotate

Annotates an alert by given Annotation Info.

Parameters

Name Key Required Type Description
Alert ID
 alertId True string

Id of the alert to annotate.
text
 text string
type
 type integer

  • 0 = None
  • 1 = Text
  • 2 = Image
userId
 userId string

Returns

Body
V2.AlertAnnotationDetails

Checks if a user has the provided permission

Operation ID:
UsersCheckPermissions

Checks if a user has the provided permission.

Parameters

Name Key Required Type Description
User ID
 userId True string

ID of the user to check permissions for.
permissions
 permissions array of string
teamIds
 teamIds array of string

Returns

Body
MultiTeamResult-2-V2.TeamPermissions-V2.PermissionError-

Close all acknowledged alerts

Operation ID:
AlertsCloseAll

This method closes all acknowledged alerts your team currently has.

Parameters

Name Key Required Type Description
User ID
 userId string

User ID of the user to be used to close the alarms.
categoryIds
 categoryIds array of string
maxDate
 maxDate date-time
minDate
 minDate date-time
scope
 scope integer

  • 0 = Default
  • 1 = AllTeams
  • 2 = SpecificTeams
teamIds
 teamIds array of string

Close an alert

Operation ID:
AlertsClose

Close an alert.

Parameters

Name Key Required Type Description
Alert ID
 alertId True string

Id to acknowledge an alert.
descr
 descr string
uid
 uid True string

Returns

Body
V2.AlertInfo

Close multiple alerts

Operation ID:
AlertsCloseMultiple

This method closes all alerts provided.

Parameters

Name Key Required Type Description
alertIds
 alertIds True array of string
descr
 descr string
uid
 uid True string

Confirms all visible alerts

Operation ID:
AlertsAcknowledgeAll

This method confirms all unhandled alerts your team currently has by a specific user.

Parameters

Name Key Required Type Description
User ID
 userId string

User ID of the user to be used to acknowledge the alarms.
categoryIds
 categoryIds array of string
maxDate
 maxDate date-time
minDate
 minDate date-time
scope
 scope integer

  • 0 = Default
  • 1 = AllTeams
  • 2 = SpecificTeams
teamIds
 teamIds array of string

Copy holidays from one team to another

Operation ID:
TeamsCopyHolidays

Copy holidays from one team to another.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

Team ID of team you want to copy holidays to
Year
 year True integer

Year you want to copy from
Team ID
 sourceTeamId True string

Team ID of team you want to copy holidays from

Returns

Body
V2.TeamHolidayDetails

Creat or Update given duty schedule

Operation ID:
DutiesCreateOrUpdate

Create/Update given duty schedule.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

Id of the team the duty is to be assigned to.
end
 end date-time
id
 id string
options
 options integer
start
 start date-time
userId
 userId string

Returns

Body
ScheduleInfo

Create a new alerting pattern

Operation ID:
TeamsCreateAlertPattern

Create a new alerting pattern.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

Team ID you want to create the pattern for
categories
 categories array of string
enabled
 enabled boolean
mode
 mode integer

  • 0 = Manager
  • 1 = Team
referenceId
 referenceId string
id
 id string
name
 name string
channel
 channel integer

  • 0 = None
  • 1 = Push
  • 2 = Voice
  • 3 = SMS
delayInMinutes
 delayInMinutes integer
enabled
 enabled boolean
overrideEscalationSettings
 overrideEscalationSettings boolean
overrideNotificationProfiles
 overrideNotificationProfiles boolean
overrideResponseSettings
 overrideResponseSettings boolean
responseMode
 responseMode integer

  • 2 = SingleAcknowledge
  • 4 = MultiAcknowledge
responseTime
 responseTime integer
suppressSignl
 suppressSignl boolean
hour
 hour integer
minutes
 minutes integer
weekday
 weekday integer

  • 0 = Holiday
  • 1 = Monday
  • 2 = Tuesday
  • 3 = Wednesday
  • 4 = Thursday
  • 5 = Friday
  • 6 = Saturday
  • 7 = Sunday
id
 id string

Returns

Body
V2.AlertingPatternDetails

Create a new category

Operation ID:
CategoriesCreate

Sample Request:

POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7
{
    "name": "Water",
    "imageName": "water.svg",
    "color": "#0000cc",
    "keywordMatching": "Any",
    "keywords": [
        {
            "value": "H2O"
        },
        {
            "value": "Water"
        }
    ]
}

Parameters

Name Key Required Type Description
Team ID
 teamId True string

ID of the team the category belongs to
enabled
 enabled boolean
id
 id string
name
 name string
type
 type True integer

  • 0 = Parameter
  • 1 = Subject
  • 2 = Text
  • 3 = Location
value
 value string
color
 color True string
id
 id string
name
 name string
type
 type True integer

  • 0 = Parameter
  • 1 = Hyperlink
value
 value string
id
 id string
imageName
 imageName True string
isDefault
 isDefault boolean
keywordMatching
 keywordMatching True integer

  • 0 = Any
  • 1 = All
keywords
 keywords True array of string
keywordsExcluded
 keywordsExcluded array of string
name
 name True string
options
 options integer

  • 0 = None
  • 1 = Hidden
  • 2 = DenyDelete
  • 4 = HideOptOut
  • 8 = HideKeywords
order
 order integer
teamId
 teamId string

Returns

Body
CategoryInfo

Create a new Remote Action

Operation ID:
RemoteActionsCreate

Sample Request:

POST /remoteActions
{
    "teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7",
    "name": "MyAction",
    "enabled": true,
}

Parameters

Name Key Required Type Description
Language
 language integer

  • 0 = EN
  • 1 = DE
name
 name True string
value
 value string
canEdit
 canEdit boolean
canExecute
 canExecute boolean
teamId
 teamId string
definitionId
 definitionId string
description
 description string
enabled
 enabled boolean
name
 name string
teamId
 teamId string

Returns

Body
V2.RemoteActionDetails

Create a new Remote Job

Operation ID:
RemoteActionsCreateJob

Sample Request:

POST /remoteActions/{actionId}/jobs
{
    "remoteActionPin" : "1234",
    "parameters": [
        {
            "name": "Param1",
            "value": "Value 1"
        }
    ]
}

Parameters

Name Key Required Type Description
Action ID
 actionId True string

Action ID
name
 name True string
value
 value string
alertId
 alertId string
options
 options integer

  • 0 = None
remoteActionPin
 remoteActionPin string

Returns

Body
V2.RemoteJob

Create event source

Operation ID:
EventSourcesCreate

Create event source.

Parameters

Name Key Required Type Description
description
 description string
disabled
 disabled boolean
language
 language integer

  • 0 = EN
  • 1 = DE
name
 name string
sharedTeams
 sharedTeams array of string
teamId
 teamId string
type
 type integer

  • 0 = None
  • 1 = Email
  • 2 = Webhook

Returns

Body
EventSourceEndpointInfo

Create new callout templates for your subscription

Operation ID:
CalloutsCreateTemplate

Create new callout templates for your subscription.

Parameters

Name Key Required Type Description
categoryId
 categoryId string
externalId
 externalId string
id
 id string
location
 location string
name
 name string
subject
 subject string
targetAllTeams
 targetAllTeams boolean
targetTeamId
 targetTeamId string
text
 text string
workflowType
 workflowType integer

  • 0 = AsConfiguredInTeam
  • 2 = TeamBroadcast
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency

Returns

response
array of V2.CalloutTemplateDetails

Create Webhook

Operation ID:
WebhooksCreate

Creates a new outbound webhook that will be notified when certain events occur.

Parameters

Name Key Required Type Description
description
 description string
extUrl
 extUrl True string
name
 name True string
teamId
 teamId string

Returns

response
string

Creates a new script instance in the in the SIGNL4 team

Operation ID:
ScriptsCreate

Creates a new script instance of the script specified in the request body.

Parameters

Name Key Required Type Description
config
 config
customScriptDescription
 customScriptDescription string
customScriptName
 customScriptName string
enabled
 enabled boolean
instanceId
 instanceId string
scriptId
 scriptId string
scriptName
 scriptName string
sharedTeams
 sharedTeams array of string
teamId
 teamId string

Returns

Body
ScriptInstanceDetails

Delete a contact address from a user

Operation ID:
UsersDeleteContactAddress

Delete a contact address from a user.

Parameters

Name Key Required Type Description
User ID
 userId True string

User ID of user to delete address from
Address ID
 addressId True string

Id of contact address

Delete a specific alerting pattern

Operation ID:
TeamsDeleteAlertPattern

Delete a specific alerting pattern.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

Team ID of team you want to access
Pattern ID
 patternId True string

Pattern ID for pattern you want to access

Delete a specific duty

Operation ID:
DutiesDelete

Delete a specific duty.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

ID of the team the duty belongs to.
Duty Schedule ID
 dutyId True string

ID of the duty to be deleted.

Delete an event distribution

Operation ID:
EventDistributionDelete

Delete an event distribution.

Parameters

Name Key Required Type Description
Event Source ID
 distributionId True string

ID of event source

Delete an event source

Operation ID:
EventSourcesDelete

Delete an event source.

Parameters

Name Key Required Type Description
Event Source ID
 eventSourceId True string

ID of event source

Delete an existing category

Operation ID:
CategoriesDelete

Sample Request:

DELETE /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e

Parameters

Name Key Required Type Description
Team ID
 teamId True string

ID of the team the category belongs to
Category ID
 categoryId True string

ID of the category to delete

Delete duty schedules in range

Operation ID:
DutiesDeleteInRange

Delete duty schedules in range.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

Team ID you want to delete
from
 from date-time
to
 to date-time

Returns

response
array of ScheduleInfo

Delete existing callout template from your subscription

Operation ID:
CalloutsDeleteTemplate

Delete existing callout template from your subscription.

Parameters

Name Key Required Type Description
Template ID
 templateId True string

Template ID.

Delete holidays

Operation ID:
TeamsDeleteHolidays

Delete holidays.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

Team ID you want to delete holidays from
day
 day integer
month
 month integer

  • 0 = Unset
  • 1 = January
  • 2 = February
  • 3 = March
  • 4 = April
  • 5 = May
  • 6 = June
  • 7 = July
  • 8 = August
  • 9 = September
  • 10 = October
  • 11 = November
  • 12 = December
year
 year integer

Delete personal user image

Operation ID:
UsersDeleteImage

Delete personal user image.

Parameters

Name Key Required Type Description
User ID
 userId True string

User id or me

Delete the phone number of a user

Operation ID:
UsersDeletePhoneNumber

Delete the phone number of a user.

Parameters

Name Key Required Type Description
User ID
 userId True string

ID of user

Delete Webhook by Id

Operation ID:
WebhooksDelete

Deletes the specified webhook so that it will no longer be notified.

Parameters

Name Key Required Type Description
Outbound Webhook ID
 webhookId True string

Id of the outbound webhook that will be deleted.

Deletes a Remote Action

Operation ID:
RemoteActionsDelete

Sample Request:

DELETE /eaRemoteActions/{actionId}

Parameters

Name Key Required Type Description
Action ID
 actionId True string

The id of the action to delete

Deletes a script instance

Operation ID:
ScriptsDelete

Gets the script instance specified by the passed instance id.

Parameters

Name Key Required Type Description
Script Instance ID
 instanceId True string

Instance Id of script instance to be returned.

Deletes current team image

Operation ID:
TeamsDeleteImage

Deletes current team image.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

Team ID you want to delete the team image from.

Deletes user account

Operation ID:
UsersDelete

Deletes user account.

Parameters

Name Key Required Type Description
User ID
 userId True string

ID of the user to be deleted.

Disables a given script instance

Operation ID:
ScriptsDisable

Disables a given script instance.

Parameters

Name Key Required Type Description
Script Instance ID
 instanceId True string

Id of the instance to be disabled.

Returns

Body
ScriptInstanceDetails

Download duty report with a specific fileName

Operation ID:
TeamsGetDutyReport

Download duty report with a specific fileName.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

ID of team you want to download the duty report for.
File Name
 fileName True string

Filename of the csv to download.

Returns

response
binary

Enables a script instance

Operation ID:
ScriptsEnable

Enables a script instance.

Parameters

Name Key Required Type Description
Script Instance ID
 instanceId True string

Id of the instance to be enabled.

Returns

Body
ScriptInstanceDetails

Escalate an alert manually to a team

Operation ID:
AlertsEscalateToTeam

Escalate an alert manually to a team.

Parameters

Name Key Required Type Description
Alert ID
 alertId True string

Alert ID for Alert you want to escalate.
targetTeamId
 targetTeamId string
userId
 userId string

Returns

response
string

Get a specific category

Operation ID:
CategoriesGet

Sample Request:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e

Parameters

Name Key Required Type Description
Team ID
 teamId True string

ID of the team the category belongs to
Category ID
 categoryId True string

ID of the category to get

Returns

Body
CategoryInfo

Get a subscription's current prepaid balance

Operation ID:
SubscriptionsGetPrepaidBalance

Get a subscription's current prepaid balance.

Parameters

Name Key Required Type Description
Subscription ID
 subscriptionId True string

ID of the subscription

Returns

Body
PrepaidBalanceInfo

Get a subscription's current prepaid settings

Operation ID:
PrepaidGetSettings84

Get a subscription's current prepaid settings.

Parameters

Name Key Required Type Description
Subscription ID
 subscriptionId True string

ID of the subscription

Returns

Body
PrepaidSettingsInfo

Get a subscription's prepaid transactions

Operation ID:
SubscriptionsGetPrepaidTransactions

Get a subscription's prepaid transactions.

Parameters

Name Key Required Type Description
Subscription ID
 subscriptionId True string

ID of the subscription to get transactions for

Returns

response
array of PrepaidTransactionInfo

Get Alert

Operation ID:
AlertsGet

Gets an alert by id.

Parameters

Name Key Required Type Description
Alert ID
 alertId True string

Id of the requested Alert.
User ID
 userId string

User ID.

Returns

Body
V2.AlertInfo

Get alert notifications

Operation ID:
AlertsGetNotifications

Get notifications of all users by alert id.

Parameters

Name Key Required Type Description
Alert ID
 alertId True string

Id of the requested Alert.

Returns

response
array of AlertNotificationInfo

Get Alert Report

Operation ID:
AlertsGetReport

Returns 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 the team members.

Parameters

Name Key Required Type Description
User ID
 userId string

User ID of the user for whom you want a report.
Team IDs
 teamId array

Team IDs of the teams you want a report for. If you don't set a team id you will get all ressources of all teams you have access to.

Returns

Body
MultiTeamResult-2-V2.AlertCountsDetails-V2.AlertReportError-

Get alert timeline entries

Operation ID:
AlertsGetTimeline

Get alert timeline entries of an alert by id.

Parameters

Name Key Required Type Description
Alert ID
 alertId True string

Id of the requested Alert.
User ID
 userId string

User ID.

Returns

Name Path Type Description
array of

Get all alerting patterns from team

Operation ID:
TeamsGetAllAlertPatterns

Get all alerting patterns from team.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

Team id of team you want to access

Returns

response
array of V2.AlertingPatternDetails

Get all callout templates for your subscription

Operation ID:
CalloutsGetTemplates

Get all callout templates for your subscription.

Returns

response
array of V2.CalloutTemplateDetails

Get all categories

Operation ID:
CategoriesGetAll

Get all categories.

Parameters

Name Key Required Type Description
Team ID
 teamId array

Team ID.

Returns

Body
MultiTeamResult-2-V2.CategoryDetails-V2.CategoryError-

Get all categories

Operation ID:
CategoriesGetAllOfTeam

Sample Request:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7

Parameters

Name Key Required Type Description
Team ID
 teamId True string

ID of the team the categories belong to

Returns

response
array of CategoryInfo

Get all teams the user is member of

Operation ID:
UsersGetAllTeams

Returns a list of team objects with details such as their name. Only teams the user is member of will be returned.

Parameters

Name Key Required Type Description
Team ID
 userId True string

Team ID.

Returns

response
array of TeamInfo

Get all Users

Operation ID:
UsersGettAll

Returns a list of user objects with details such as their email address and duty information. Only users you have access to will be returned.

Returns

response
array of V2.UserDetails

Get attachment infos of an alert

Operation ID:
AlertsGetAttachmentInfo

Get attachments of an alert by id.

Parameters

Name Key Required Type Description
Alert ID
 alertId True string

Id of the requested Alert.

Returns

response
array of V2.AlertAttachmentInfo

Get category subscriptions

Operation ID:
CategoriesGetSubscription

Sample Request:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions
{
}

Parameters

Name Key Required Type Description
Team ID
 teamId True string

ID of the team the category belongs to
Category ID
 categoryId True string

Category to get subscriptions for

Returns

response
array of CategorySubscriptionInfo

Get details about an alert

Operation ID:
AlertsGetDetails

Get details about an alert.

Parameters

Name Key Required Type Description
Alert ID
 alertId True string

Alert you want to get.
User ID
 userId string

User ID of user in which behave the api is called. It is used for filtering purposes regarding the alert.

Returns

Body
V2.AlertDetails

Get details of an event

Operation ID:
EventsGetDetails

Get details of an event.

Parameters

Name Key Required Type Description
Event ID
 eventId True string

Event id for the event you want to get

Returns

Body
V2.EventDetails

Get duty assistant info for teams

Operation ID:
DutiesGetDutyAssistantInfo

Get duty assistant info for teams.

Parameters

Name Key Required Type Description
Team IDs
 teamId array

IDs of the teams to get the summaries for.
Last Two Duties
 lastTwoDuties boolean

Decide if you want all duties or only the last two.

Returns

Body
MultiTeamResult-2-TeamDutySummaryInfo-V2.TeamDutySummaryError-

Get duty status by user Id

Operation ID:
UsersGetDutyStatus

Returns a object with duty information.

Parameters

Name Key Required Type Description
User ID
 userId True string

Identifier of the user to get. Use 'Me' to get information about the currently logged in user. This is not possible with an api key. Can also be an email address of a user in the team or the unique id of an according user object.”
Team ID
 teamId array

Team ID.”

Returns

Body
MultiTeamResult-2-UserDutyInfo-V2.DutyError-

Get event parameters

Operation ID:
EventsGetParameters

Get parameters of an event by id.

Parameters

Name Key Required Type Description
Event ID
 eventId True string

Event Id of the requested Alert.

Returns

response
array of EventParameterInfo

Get event source by id

Operation ID:
EventSourcesGetById

Get event source by id.

Parameters

Name Key Required Type Description
Event Source ID
 eventSourceId True string

Id of the event source.
Language
 language integer

  • 0 = EN
  • 1 = DE

Returns

Body
EventSourceEndpointInfo

Get event sources from one or more teams

Operation ID:
EventSourcesGet

Get event sources from one or more teams.

Parameters

Name Key Required Type Description
Team IDs
 teamId array

Team Ids to get the event sources from. If you don't add any team id, you get event sources you have access to from your subscription.
Include Internal
 includeInternal boolean

If true internal Event Sources type (System, Manual, API) will be included in the result.
Language
 language integer

  • 0 = EN
  • 1 = DE

Returns

Body
MultiTeamResult-2-EventSourceEndpointInfo-V2.EventSourceEndpointError-

Get holidays for team

Operation ID:
TeamsGetHolidays

Get holidays for team.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

Team ID you want to get holidays from

Returns

Body
V2.TeamHolidayDetails

Get information about downloadable alert reports

Operation ID:
TeamsGetAlertReportsInfo

Get information about downloadable alert reports.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

ID of team you want to download reports from.

Returns

response
array of AlertAuditReportFileInfo

Get infos for all teams of the subscription

Operation ID:
SubscriptionsGetAllTeamsInfo

Get infos for all teams of the subscription.

Parameters

Name Key Required Type Description
Subscription ID
 subscriptionId True string

ID of the subscription to be updated

Returns

response
array of TeamInfo

Get infos of a specific subscription

Operation ID:
SubscriptionsGetInfo

Get infos of a specific subscription.

Parameters

Name Key Required Type Description
Subscription ID
 subscriptionId True string

Id of the subscription that's to be retrieved.

Returns

Body
SubscriptionInfo

Get infos of all available and managed subscriptions

Operation ID:
SubscriptionsGetAll

Get infos of all available/managed subscriptions.

Returns

response
array of SubscriptionInfo

Get infos of all teams

Operation ID:
TeamsGetAllInfo

Get infos of all teams.

Parameters

Name Key Required Type Description
Team IDs
 teamId array

Team IDs

Returns

response
array of TeamInfo

Get metrics for a specific category

Operation ID:
CategoriesGetMetrics

Sample Request:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/metrics

Parameters

Name Key Required Type Description
Team ID
 teamId True string

ID of the team the category belongs to
Category ID
 categoryId True string

ID of the category to get

Returns

Body
CategoryMetrics

Get metrics for all categories

Operation ID:
CategoriesGetAllMetrics

Sample Request:

GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/metrics

Parameters

Name Key Required Type Description
Team ID
 teamId True string

ID of the team the categories belongs to

Returns

response
array of CategoryMetrics

Get notification profiles for user

Operation ID:
UsersGetNotificationProfile

Get notification profiles for user.

Parameters

Name Key Required Type Description
User ID
 userId True string

Id of the user you want to get the notification profiles from.

Returns

response
array of V2.NotificationProfileDetails

Get overview event

Operation ID:
EventsGetOverview

Get overview event by id.

Parameters

Name Key Required Type Description
Event ID
 eventId True string

Id of event to get.

Returns

Body
OverviewEvent

Get overview event paged

Operation ID:
EventsGetOverviewPaged

Get overview event paged. If there are more results, you also get a continuation token which you can add to the event filter.

Parameters

Name Key Required Type Description
Limit
 maxResults integer

Defines the limit of retrieved alert details per request. 1 to 100 are allowed per request. Number of alerts could be less if filtered but at least 1.
nextPartitionKey
 nextPartitionKey string
nextRowKey
 nextRowKey string
nextTableName
 nextTableName string
eventSourceId
 eventSourceId string
eventStatusCode
 eventStatusCode integer

  • 0 = None
  • 1 = Processing
  • 2 = Signled
  • 3 = Filtered
  • 4 = Resolved
  • 5 = Discarded
  • 6 = Acknowledged
  • 7 = Suppressed
  • 8 = NoRuleApplied
  • 9 = MultipleTargetStatus
  • 1000 = Error
maxCreationDate
 maxCreationDate date-time
minCreationDate
 minCreationDate date-time
modifiedSince
 modifiedSince date-time
teamid
 teamid string
textToSearch
 textToSearch string

Returns

Body
PagedResultsPublic-1-OverviewEvent-

Get personal user image

Operation ID:
UsersGetImage

Get personal user image.

Parameters

Name Key Required Type Description
User ID
 userId True string

User ID.”
Image Height
 height integer

Image height.”
Image Width
 width integer

Image width.”

Returns

Body
UserImage

Get public information about all teams in a subscription

Operation ID:
TeamsGetAllPublicInformation

Get public information about all teams in a subscription.

Returns

response
array of V2.TeamPublicDetails

Get team duty settings for multiple teams

Operation ID:
TeamsGetDutySettings

Get team duty settings for multiple teams.

Parameters

Name Key Required Type Description
Team IDs
 teamId array

Team IDs.

Returns

Body
MultiTeamResult-2-V2.TeamDutySettingsDetails-V2.TeamDutySettingsError-

Get team memberships by team

Operation ID:
TeamsGetMemberships

Get team memberships by team.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

Team ID of team you want to access.

Returns

response
array of V2.TeamMembershipDetails

Get Team memberships from a user

Operation ID:
TeamsGetTeamMemberships

Get Team memberships from a user.

Parameters

Name Key Required Type Description
User ID
 userId True string

User ID you want to access.

Returns

response
array of V2.TeamMembershipDetails

Get Team privacy settings for a team

Operation ID:
TeamsGetPrivacySettings

Get Team privacy settings for a team.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

Team ID of team

Returns

Body
V2.TeamPrivacySettingsDetails

Get User by Id

Operation ID:
UsersGet

Returns a user object with details such as his email address and duty information.

Parameters

Name Key Required Type Description
User ID
 userId True string

Identifier of the user to get. Use 'Me' to get information about the currently logged in user. This is not possible with an api key. Can also be an email address of a user in the team or the unique id of an according user object.”

Returns

Body
V2.UserDetails

Get Webhook by Id

Operation ID:
WebhooksGet

Returns information of the webhook specified by the passed id.

Parameters

Name Key Required Type Description
Outbound Webhook ID
 webhookId True string

Id of the outbound webhook to be retrieved.

Returns

Body
WebhookInfo

Get Webhooks

Operation ID:
WebhooksGetAll

Returns a collection of defined outbound webhooks in the system.

Parameters

Name Key Required Type Description
Team ID
 teamId string

Team ID.

Returns

response
array of WebhookInfo

Get your subscription's current prepaid balance

Operation ID:
PrepaidGetBalance

Get your subscription's current prepaid balance.

Returns

Body
PrepaidBalanceInfo

Get your subscription's current prepaid settings

Operation ID:
PrepaidGetSettings

Get your subscription's current prepaid settings.

Returns

Body
PrepaidSettingsInfo

Get your subscription's prepaid transactions

Operation ID:
PrepaidGetTransactions

Get your subscription's prepaid transactions.

Returns

response
array of PrepaidTransactionInfo

Gets a specified attachment of a specified alert

Operation ID:
AlertsGetAttachment

Gets a specified attachment of a specified alert.

Parameters

Name Key Required Type Description
Alert ID
 alertId True string

Id of the alert that contains the wanted attachment.
Attachment ID
 attachmentId True string

Id of the attachment, that you want to retrieve.
Image Width
 width integer

Optional parameter defining the wanted width of the picture that is retrieved.
Image Height
 height integer

Optional parameter defining the wanted height of the picture that is retrieved.
Scale
 scale boolean

Optional parameter defining whether it's wanted to scale the retrieved image. Default is set to true.

Returns

response
binary

Gets a subscription's user licenses

Operation ID:
SubscriptionsGetUserLicenses

Gets a subscription's user licenses.

Parameters

Name Key Required Type Description
Subscription ID
 subscriptionId True string

ID of the subscription

Returns

Body
UserLicenseInfo

Gets a subscription's voice number licenses

Operation ID:
SubscriptionsGetVoiceNumberLicense

Gets a subscription's voice number licenses.

Parameters

Name Key Required Type Description
Subscription ID
 subscriptionId True string

ID of the subscription

Returns

Body
UserLicenseInfo

Gets alert settings of a specific team

Operation ID:
TeamsGetAlertSettings

Gets alert settings of a specific team.

Parameters

Name Key Required Type Description
Team ID
 teamId array

ID of the team.

Returns

Body
MultiTeamResult-2-V2.AlertSettingsDetails-V2.AlertSettingsError-

Gets alert settings of a specific team

Operation ID:
TeamsGetAlertSettings99

Gets alert settings of a specific team.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

ID of the team the settings should be retrieved for.

Returns

Body
AlertSettings

Gets alerts paged

Operation ID:
AlertsGetPaged

Gets alerts paged.

Parameters

Name Key Required Type Description
User ID
 userId string

User ID of the user you want to get alerts for.
Alert limit
 maxResults integer

Defines the limit of retrieved alert details per request. 1 to 100 are allowed per request. Number of alerts could be less if filtered but at least 1.
afterId
 afterId string
alertIds
 alertIds array of string
alertStatusCodes
 alertStatusCodes integer

  • 0 = None
  • 1 = Open
  • 2 = Acknowledged
  • 4 = Closed
  • 8 = NoReply
  • 16 = Failed
  • 32 = Error
categoryIds
 categoryIds array of string
nextPartitionKey
 nextPartitionKey string
nextRowKey
 nextRowKey string
nextTableName
 nextTableName string
externalId
 externalId string
maxCreated
 maxCreated date-time
minCreated
 minCreated date-time
modifiedSince
 modifiedSince date-time
showPersonalHiddenCategories
 showPersonalHiddenCategories boolean
teamIds
 teamIds array of string
textToSearch
 textToSearch string

Returns

Body
PagedResultsPublic-1-V2.AlertInfo-

Gets event sources of a specific team

Operation ID:
TeamsGetEventSources

Gets event sources of a specific team.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

ID of the team the sources should be retrieved for.

Returns

response
array of EventSourceEndpointInfo

Gets image of a specified team

Operation ID:
TeamsGetImage

Gets image of a specified team.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

The id of the team you want to get the image from.
Image Height
 height integer

Optional parameter defining the wanted height of the picture thats retrieved.
Image Width
 width integer

Optional parameter defining the wanted width of the picture thats retrieved.

Returns

Body
V2.TeamImageDetails

Gets infos of a specific team

Operation ID:
TeamsGetInfo

Gets infos of a specific team.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

ID of the team that should be retrieved.

Returns

Body
TeamInfo

Gets setup progress of a specific team

Operation ID:
TeamsGetSetupProgress

Gets setup progress of a specific team.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

ID of the team the progress should be retrieved for.

Returns

Body
TeamSetupProgress

Gets setup progress of a specific user

Operation ID:
UsersGetSetupProgress

Gets setup progress of a specific user.

Parameters

Name Key Required Type Description
User ID
 userId True string

ID of the user the progress should be retrieved for.

Returns

Body
UserSetupProgress

Gets the names of all alert category images

Operation ID:
CategoriesGetImageNames

Gets the names of all alert category images. You can get the image by going to account.signl4.com/images/alerts/categoryImageName.svg.

Returns

Name Path Type Description
array of string

Getting all users of specified teams

Operation ID:
TeamsGetAllUsers

Getting all users of specified teams.

Parameters

Name Key Required Type Description
Team IDs
 teamId array

Team ids to request. If empty, you get all users of all teams you have access to.

Returns

Body
MultiTeamResult-2-V2.UserDetails-V2.TeamUserError-

Invite users to a team

Operation ID:
TeamsInviteUser

Invite users to a team.

Parameters

Name Key Required Type Description
inviterId
 inviterId string
email
 email string
roleId
 roleId string
teamId
 teamId True string

Returns

response
array of V2.InvitationResult

Punch User in

Operation ID:
DutiesUserPunchIn

The specified user will be punched in to duty.

Parameters

Name Key Required Type Description
teamIds
 teamIds array of string
userId
 userId True string

Returns

Body
MultiTeamResult-2-V2.UserDutyDetails-V2.DutyChangeError-

Punch User in as Manager

Operation ID:
DutiesUserPunchInAsManager

The specified user will be punched in to duty as a manager.

Parameters

Name Key Required Type Description
teamIds
 teamIds array of string
userId
 userId True string

Returns

Body
MultiTeamResult-2-V2.UserDutyDetails-V2.DutyChangeError-

Punch User out

Operation ID:
DutiesUserPunchOut

The specified user will be punched out from duty.

Parameters

Name Key Required Type Description
teamIds
 teamIds array of string
userId
 userId True string

Returns

Body
MultiTeamResult-2-V2.UserDutyDetails-V2.DutyChangeError-

Queue undo of multiple acknowledgments

Operation ID:
AlertsUndoAcknowledgeMultiple

This method tries to undo the acknowledgement of multiple alerts via a queue. The operation is handled in the background.

Parameters

Name Key Required Type Description
alertIds
 alertIds True array of string
descr
 descr string
uid
 uid True string

Removes a user or invitation from a team

Operation ID:
TeamsRemoveUser

Removes a user or invitation from a team.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

ID of the team the user should be deleted from
User ID
 userId True string

ID of the user that should be deleted
User ID
 requesterUserId string

User ID of user which will remove the other user.

Retrieve a definition

Operation ID:
RemoteActionsGetDefinition

Retrieve a definition.

Parameters

Name Key Required Type Description
Definition ID
 definitionId True string

Id of definition
Language
 language integer

  • 0 = EN
  • 1 = DE

Returns

Body
V2.RemoteActionDefinitionDetails

Retrieve all available definition

Operation ID:
RemoteActionsGetAvailableDefinitions

Retrieve all available definition.

Parameters

Name Key Required Type Description
Language
 language integer

  • 0 = EN
  • 1 = DE

Returns

response
array of V2.RemoteActionDefinitionDetails

Returns a Remote Action

Operation ID:
RemoteActionsGet

Sample Request:

GET /RemoteActions/{actionId}

Parameters

Name Key Required Type Description
Action ID
 actionId True string

The id of the action to return
Language
 language integer

  • 0 = EN
  • 1 = DE

Returns

Body
V2.RemoteActionDetails

Returns a Remote Job from Journal

Operation ID:
RemoteActionsGetJob

Sample Request:

GET /remoteActions/journal/{jobId}

Parameters

Name Key Required Type Description
Job ID
 jobId True string

The id of the job to return
Language
 language integer

  • 0 = EN
  • 1 = DE

Returns

Body
V2.RemoteJob

Returns Alert Report

Operation ID:
TeamsGetAlertReport

Returns Alert Report.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

ID of team you want to get the duty report file infos for.
File Name
 fileName True string

File name of file you want to download.

Returns

response
binary

Returns all available inventory scripts

Operation ID:
ScriptsGetAvailable

Returns all available inventory scripts which can be added to a SIGNL4 subscription.

Returns

response
array of InventoryScriptInfo

Returns all information about a given script instance

Operation ID:
ScriptsGetInfo

Gets the script instance specified by the passed instance id.

Parameters

Name Key Required Type Description
Script Instance ID
 instanceId True string

Instance Id of script instance to be returned.

Returns

Body
ScriptInstanceDetails

Returns all inventory scripts

Operation ID:
ScriptsGetAll76

Returns all inventory scripts.

Parameters

Name Key Required Type Description
Language
 language string

Language

Returns

response
array of InventoryScriptInfo

Returns all script instances of the SIGNL4 team

Operation ID:
ScriptsGetAll

Returns all script instances in the subscription.

Parameters

Name Key Required Type Description
Team IDs
 teamId array

Team IDs.
Modified Since
 modifiedSince date-time

Modified Since.

Returns

response
array of ScriptInstanceInfo

Returns an inventory script by its id

Operation ID:
ScriptsGet

Gets the script specified by the passed script id.

Parameters

Name Key Required Type Description
Script ID
 scriptId True string

The Id of the script to be returned.
Language
 language string

Language

Returns

Body
ScriptInstanceDetails

Returns information about all planned schedules

Operation ID:
SchedulesGetPlanned

Returns information about all planned schedules.

Parameters

Name Key Required Type Description
limit
 limit integer
minDate
 minDate date-time
teamIds
 teamIds array of string
userId
 userId string

Returns

response
array of V2.ScheduleDetails

Returns information of the duty schedule with the specified Id

Operation ID:
DutiesGetInfo

Returns information of the duty schedule with the specified Id.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

Id of the team the duty belongs to
Duty Schedule ID
 scheduleId True string

Id of the requested duty schedule.

Returns

Body
ScheduleInfo

Returns Remote Actions

Operation ID:
RemoteActionsGetActions

Sample Request:

GET /RemoteActions?externalId=12345

Parameters

Name Key Required Type Description
Team ID
 teamId string

Team ID
External ID
 externalId string

Optional filter for external id
Type
 type integer

  • 0 = Unknown
  • 1 = Script
  • 2 = EnterpriseAlert
  • 3 = Webhook
Executor Service
 executorService string

Executor Service
Language
 language integer

  • 0 = EN
  • 1 = DE

Returns

response
array of V2.RemoteActionInfo

Returns Remote Jobs paged from Journal

Operation ID:
RemoteActionsGetJobsPaged

Sample Request:

POST /remoteActions/journal/paged?maxResults=100
{
    "statusCode": "Executed"
}

Parameters

Name Key Required Type Description
Max Results
 maxResults integer

Max Results
Language
 language integer

  • 0 = EN
  • 1 = DE
actionId
 actionId string
continuationToken
 continuationToken string
maxCreationDate
 maxCreationDate date-time
minCreationDate
 minCreationDate date-time
modifiedSince
 modifiedSince date-time
statusCodes
 statusCodes integer

  • 0 = None
  • 1 = Pending
  • 2 = Ready
  • 4 = Running
  • 8 = Executed
  • 16 = Error

Returns

Body
PagedResultsPublic-1-V2.RemoteJob-

Returns the features of a specified subscription

Operation ID:
SubscriptionsGetFeatures

Returns the features of a specified subscription.

Parameters

Name Key Required Type Description
Subscription ID
 subscriptionId True string

Id of the subscription from which the features need to be retrieved.

Returns

response
array of SubscriptionFeature

Returns the subscription's channel price information

Operation ID:
SubscriptionsGetChannelPriceInfo

Returns the subscription's channel price information.

Parameters

Name Key Required Type Description
Subscription ID
 subscriptionId True string

Id of the subscription that needs to be retrieved.

Returns

Body
ChannelPriceInfo

Save holidays for a team

Operation ID:
TeamsSaveHolidays

Save holidays for a team.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

Team ID of team you want to save holidays for
Year
 year True integer

Year you want to save holidays for
day
 day integer
month
 month integer

  • 0 = Unset
  • 1 = January
  • 2 = February
  • 3 = March
  • 4 = April
  • 5 = May
  • 6 = June
  • 7 = July
  • 8 = August
  • 9 = September
  • 10 = October
  • 11 = November
  • 12 = December

Returns

Body
V2.TeamHolidayDetails

Save multiple schedules

Operation ID:
DutiesSaveMultiple

Save multiple schedules. It is possible to override existing schedules if you wish.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

Team ID to set
Override
 overrideExisting boolean

Override or cut existing schedules if set to true.
end
 end date-time
id
 id string
options
 options integer
start
 start date-time
userId
 userId string

Returns

response
array of ScheduleInfo

Save repeating holidays for a team

Operation ID:
TeamsSaveRepeatingHolidays

Save repeating holidays for a team.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

Team ID of team you want to save holidays for
day
 day integer
month
 month integer

  • 0 = Unset
  • 1 = January
  • 2 = February
  • 3 = March
  • 4 = April
  • 5 = May
  • 6 = June
  • 7 = July
  • 8 = August
  • 9 = September
  • 10 = October
  • 11 = November
  • 12 = December

Returns

Body
V2.TeamHolidayDetails

Send event

Operation ID:
EventsSend

Send event.

Parameters

Name Key Required Type Description
Team Secret
 teamSecret True string

Team Secret.
Title
 Title True string
Message
 Message True string
X-S4-Service
 X-S4-Service string

X-S4-Service: : Assigns the Signl to the service / system category with the specified name.
X-S4-Location
 X-S4-Location string

X-S4-Location: Transmit location information (latitude,longitude) with your event and display a map in the mobile app.
X-S4-AlertingScenario
 X-S4-AlertingScenario string

X-S4-AlertingScenario: If this event triggers a Signl, allows to control how SIGNL4 notifies the team. Supported values are: single_ack, multi_ack, emergency.
X-S4-ExternalID
 X-S4-ExternalID string

X-S4-ExternalID: If the event originates from a record in a 3rd party system, use this parameter to pass the unique ID of that record. That ID will be communicated in outbound webhook notifications from SIGNL4, which is great for correlation/synchronization of that record with the Signl.
X-S4-Status
 X-S4-Status string

X-S4-Status: If you want to resolve an existing Signl by an external id (X-S4-ExternalID), you can add this status parameter. It has three possible values: new, acknowledged, resolved.
X-S4-Filtering
 X-S4-Filtering boolean

X-S4-Filtering: Specify a boolean value of true or false to apply event filtering for this event, or not. If set to true, the event will only trigger a notification to the team, if it contains at least one keyword from one of your services and system categories (i.e. it is whitelisted).
External ID Parameter
 ExtIdParam string

External ID Parameter.
External Status Parameter
 ExtStatusParam string

External Status Parameter.
New Status
 NewStatus string

New Status.
Resolved Status Parameter
 ResolvedStatus string

Resolved Status Parameter.
Ack Status
 AckStatus string

Ack Status.

Returns

Body
OverviewEvent

Sends a mail to a specified user

Operation ID:
UsersSendEventSourceInfoEmail

Sends a mail to a specified user that contains information of all event sources of the user's team.

Parameters

Name Key Required Type Description
User ID
 userId True string

The user id.
Team ID
 teamId string

The team Id from which the user should get the endpoint information.

Sends invite email again if an invite exists

Operation ID:
TeamsResendInvite

Sends invite email again if an invite exists.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

Team ID of team with invited user.
inviterId
 inviterId string
userMail
 userMail True string

Returns

response
string

Set category subscriptions

Operation ID:
CategoriesSetSubscription

Sample Request:

POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e/subscriptions
{
}

Parameters

Name Key Required Type Description
Team ID
 teamId True string

ID of the team the category belongs to
Category ID
 categoryId True string

Category to be updated
status
 status True integer

  • 0 = Subscribed
  • 1 = Muted
  • 2 = Hidden
userId
 userId True string

Returns

response
array of CategorySubscriptionInfo

Set location of an user

Operation ID:
UsersSetLocation

Set location of an user.

Parameters

Name Key Required Type Description
User ID
 userId True string

ID of user.
latitude
 latitude double
longitude
 longitude double
timestamp
 timestamp date-time

Returns

Body
LocationInfo

Set notification profiles for user

Operation ID:
UsersSetNotificationProfile

Set notification profiles for user.

Parameters

Name Key Required Type Description
User ID
 userId True string

Id of the user you want to get the notification profiles from.
channel
 channel integer

  • 0 = None
  • 1 = Push
  • 2 = Email
  • 4 = Bot
  • 8 = Voice
  • 16 = SMS
delayInMinutes
 delayInMinutes integer
enabled
 enabled boolean
options
 options integer
persistent
 persistent boolean

Returns

response
array of V2.NotificationProfileDetails

Set the phone number of a user

Operation ID:
UsersSetPhoneNumber

Set the phone number of a user. If another phone number is saved, it will be overwritten.

Parameters

Name Key Required Type Description
User ID
 userId True string

User ID of the user you want to add a phone number to
countryCode
 countryCode string
phoneNumber
 phoneNumber string
sendValidationCode
 sendValidationCode boolean
sendValidationCodeVia
 sendValidationCodeVia integer

  • 0 = None
  • 1 = SMS
  • 2 = Voice

Returns

Body
V2.UserPhoneNumberDetails

Sets alert settings of a specific team

Operation ID:
TeamsSetAlertSettings

Sets alert settings of a specific team.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

ID of the team the settings should be set for.
escEnabled
 escEnabled boolean
escMode
 escMode integer

  • 0 = Manager
  • 1 = Team
escRefId
 escRefId string
filterAction
 filterAction integer

  • 0 = Suppress
  • 1 = Hide
  • 2 = Mute
filterMode
 filterMode integer

  • 0 = Off
  • 1 = WhiteListAllCategories
channel
 channel integer

  • 0 = None
  • 1 = Push
  • 2 = Voice
  • 3 = SMS
delay
 delay integer
enabled
 enabled boolean
optOut
 optOut integer

  • 0 = None
  • 1 = Disabled
  • 2 = Personal
overrideNotificationProfiles
 overrideNotificationProfiles boolean
persNotInterval
 persNotInterval integer
persNotMode
 persNotMode integer

  • 0 = Off
  • 1 = Summary
responseMode
 responseMode integer

  • 2 = SingleAcknowledge
  • 4 = MultiAcknowledge
responseTime
 responseTime integer

Returns

Body
AlertSettings

Trigger Alert

Operation ID:
AlertsTrigger

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

Parameters

Name Key Required Type Description
name
 name string
order
 order integer
type
 type integer

  • 0 = None
  • 1 = Object
  • 2 = Array
  • 3 = Constructor
  • 4 = Property
  • 5 = Comment
  • 6 = Integer
  • 7 = Float
  • 8 = String
  • 9 = Boolean
  • 10 = Null
  • 11 = Undefined
  • 12 = Date
  • 13 = Raw
  • 14 = Bytes
  • 15 = Guid
  • 16 = Uri
  • 17 = TimeSpan
  • 100 = Html
value
 value string
content
 content string
contentType
 contentType string
encoding
 encoding integer

  • 0 = None
  • 1 = Base64
id
 id string
name
 name string
category
 category string
externalId
 externalId string
flags
 flags integer

  • 0 = None
  • 1 = HasAttachments
  • 2 = HasAnnotations
  • 4 = IsBreached
  • 8 = HasLocationInfo
  • 16 = EscalatedToTeam
  • 32 = EscalatedToManager
  • 64 = CreatedByEscalation
severity
 severity integer

  • 0 = Low
  • 1 = Major
  • 2 = Critical
teamId
 teamId True string
text
 text True string
title
 title True string

Returns

Body
V2.AlertDetails

Undo the acknowledgement of an alert

Operation ID:
AlertsUndoAck

This method tries to undo an alert acknowledgement.

Parameters

Name Key Required Type Description
Alert ID
 alertId True string

Alert ID.
descr
 descr string
uid
 uid True string

Returns

Body
V2.AlertInfo

Undo the closure of an alert

Operation ID:
AlertsUndoClose

This method tries to undo an alert close.

Parameters

Name Key Required Type Description
Alert ID
 alertId True string

Alert ID.
descr
 descr string
uid
 uid True string

Returns

Body
V2.AlertInfo

Update a subscription's current prepaid settings

Operation ID:
PrepaidUpdateSettings55

Update a subscription's current prepaid settings.

Parameters

Name Key Required Type Description
Subscription ID
 subscriptionId True string

ID of the subscription
topUpAmount
 topUpAmount integer
topUpEnabled
 topUpEnabled boolean
topUpLimit
 topUpLimit integer

Returns

Body
PrepaidSettingsInfo

Update an event source

Operation ID:
EventSourcesUpdate

Update an event source.

Parameters

Name Key Required Type Description
Event Source ID
 eventSourceId True string

ID of event source
description
 description string
disabled
 disabled boolean
name
 name string
teamId
 teamId string

Returns

Body
EventSourceEndpointInfo

Update an existing alerting pattern

Operation ID:
TeamsUpdateAlertPattern

Update an existing alerting pattern.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

Team ID you want to create the pattern for
Pattern ID
 patternId True string

Pattern ID of pattern to update
categories
 categories array of string
enabled
 enabled boolean
mode
 mode integer

  • 0 = Manager
  • 1 = Team
referenceId
 referenceId string
id
 id string
name
 name string
channel
 channel integer

  • 0 = None
  • 1 = Push
  • 2 = Voice
  • 3 = SMS
delayInMinutes
 delayInMinutes integer
enabled
 enabled boolean
overrideEscalationSettings
 overrideEscalationSettings boolean
overrideNotificationProfiles
 overrideNotificationProfiles boolean
overrideResponseSettings
 overrideResponseSettings boolean
responseMode
 responseMode integer

  • 2 = SingleAcknowledge
  • 4 = MultiAcknowledge
responseTime
 responseTime integer
suppressSignl
 suppressSignl boolean
hour
 hour integer
minutes
 minutes integer
weekday
 weekday integer

  • 0 = Holiday
  • 1 = Monday
  • 2 = Tuesday
  • 3 = Wednesday
  • 4 = Thursday
  • 5 = Friday
  • 6 = Saturday
  • 7 = Sunday
id
 id string

Returns

Body
V2.AlertingPatternDetails

Update an existing category

Operation ID:
CategoriesUpdate

Sample Request:

PUT /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e
{
    "name": "Water-Updated",
    "imageName": "water.svg",
    "color": "#0000cc",
    "keywordMatching": "All",
    "keywords": [
        {
            "value": "H2O"
        },
        {
            "value": "Water"
        },
        {
            "value": "Wet"
        }
    ]
}

Parameters

Name Key Required Type Description
Team ID
 teamId True string

ID of the team the category belongs to
Category ID
 categoryId True string

Category ID
enabled
 enabled boolean
id
 id string
name
 name string
type
 type True integer

  • 0 = Parameter
  • 1 = Subject
  • 2 = Text
  • 3 = Location
value
 value string
color
 color True string
id
 id string
name
 name string
type
 type True integer

  • 0 = Parameter
  • 1 = Hyperlink
value
 value string
id
 id string
imageName
 imageName True string
isDefault
 isDefault boolean
keywordMatching
 keywordMatching True integer

  • 0 = Any
  • 1 = All
keywords
 keywords True array of string
keywordsExcluded
 keywordsExcluded array of string
name
 name True string
options
 options integer

  • 0 = None
  • 1 = Hidden
  • 2 = DenyDelete
  • 4 = HideOptOut
  • 8 = HideKeywords
order
 order integer
teamId
 teamId string

Returns

Body
CategoryInfo

Update existing callout template for your subscription

Operation ID:
CalloutsUpdateTemplate

Update existing callout template for your subscription.

Parameters

Name Key Required Type Description
Template ID
 templateId True string

ID of template you want to update
categoryId
 categoryId string
externalId
 externalId string
id
 id string
location
 location string
name
 name string
subject
 subject string
targetAllTeams
 targetAllTeams boolean
targetTeamId
 targetTeamId string
text
 text string
workflowType
 workflowType integer

  • 0 = AsConfiguredInTeam
  • 2 = TeamBroadcast
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency

Returns

response
array of V2.CalloutTemplateDetails

Update locale info (e.g. language, time zone) for user

Operation ID:
UsersUpdateLocaleInfo

Update locale info (e.g. language, time zone) for user.

Parameters

Name Key Required Type Description
User ID
 userId True string

User ID, email or "me" for user you want to update
language
 language string
timeZone
 timeZone string

Returns

Body
V2.UserLocaleResponseDetails

Update privacy settings for a team

Operation ID:
TeamsUpdatePrivacySettings

Update privacy settings for a team.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

Team ID of team
hideContactAddresses
 hideContactAddresses boolean
hideDutyData
 hideDutyData boolean
hideForEscalation
 hideForEscalation boolean

Returns

Body
V2.TeamPrivacySettingsDetails

Update user's team membership

Operation ID:
TeamsUpdateUserMembership

Updates the user's team membership. You can move the user to another team within the subscription and/or change the user's role.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

Team the user you want to update belongs to at the moment.
User ID
 userId True string

User ID of user you want to update.
User ID
 requesterUserId string

User ID of user which you want to change role with. This must be provided when using an api key. This user must have role administrator (for setting administrator role) or team administrator (for setting rights.
Set User On Duty
 setUserOnDuty boolean

Sets new duty status for user if user is moved to a different team. User is on duty be default.
isValid
 isValid boolean
roleId
 roleId string
teamId
 teamId string

Returns

Body
UserInfo

Update Webhook by Id

Operation ID:
WebhooksUpdate

Updates the specified webhook.

Parameters

Name Key Required Type Description
Outbound Webhook ID
 webhookId True string

Id of the outbound webhook to be updated.
description
 description string
extUrl
 extUrl True string
name
 name True string
teamId
 teamId string

Returns

Body
WebhookInfo

Update your subscription's current prepaid settings

Operation ID:
PrepaidUpdateSettings

Update your subscription's current prepaid settings.

Parameters

Name Key Required Type Description
topUpAmount
 topUpAmount integer
topUpEnabled
 topUpEnabled boolean
topUpLimit
 topUpLimit integer

Returns

Body
PrepaidSettingsInfo

Updates a given script instance

Operation ID:
ScriptsUpdateConfig

Updates the specified script instance, typically used for updating the configuration of a script.

Parameters

Name Key Required Type Description
Script Instance ID
 instanceId True string

Instance Id of the script to be updated.
config
 config
customScriptDescription
 customScriptDescription string
customScriptName
 customScriptName string
enabled
 enabled boolean
teamId
 teamId string

Returns

Body
ScriptInstanceDetails

Updates a Remote Action

Operation ID:
RemoteActionsUpdate

Sample Request:

PUT /remoteActions/{actionId}
{
    "teamId": "cbb70402-1359-477f-ac92-0171cf2b5ff7",
    "name": "MyAction",
    "enabled": true,
}

Parameters

Name Key Required Type Description
Action ID
 actionId True string

Id of remote Action to be updated
Action ID
 language integer

  • 0 = EN
  • 1 = DE
name
 name True string
value
 value string
canEdit
 canEdit boolean
canExecute
 canExecute boolean
teamId
 teamId string
definitionId
 definitionId string
description
 description string
enabled
 enabled boolean
name
 name string
teamId
 teamId string

Returns

Body
V2.RemoteActionDetails

Updates a subscriptions profile

Operation ID:
SubscriptionsUpdateProfile

Updates a subscriptions profile.

Parameters

Name Key Required Type Description
Subscription ID
 subscriptionId True string

ID of the subscription to be updated
name
 name string

Returns

Body
SubscriptionInfo

Updates custom data of a given script instance which includes its display name

Operation ID:
ScriptsUpdateCustomData

Updates the specified script instance.

Parameters

Name Key Required Type Description
Script Instance ID
 instanceId True string

Instance Id of the script to be updated.
customScriptDescription
 customScriptDescription string
customScriptName
 customScriptName string
instanceId
 instanceId string
scriptName
 scriptName string

Returns

Body
ScriptInstanceDetails

Updates team profile of a team

Operation ID:
TeamsUpdateProfile

Updates team profile of a team.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

Team ID of team which should be updated.
name
 name string

Returns

Body
TeamInfo

Updates the password of a user

Operation ID:
UsersUpdatePassword

Updates the password of a user.

Parameters

Name Key Required Type Description
User ID
 userId True string

User ID of user whose password should be changed.
currentPassword
 currentPassword string
newPassword
 newPassword string

Updates user profile of an user

Operation ID:
UsersUpdateProfile

Updates user profile of an user.

Parameters

Name Key Required Type Description
User ID
 userId True string

ID of user to update.
name
 name string
timeZone
 timeZone string

Returns

Body
UserInfo

Uploaded a profile image for a specified team

Operation ID:
TeamsUploadImage

Uploaded a profile image for a specified team.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

Team ID where to set the team image.

Uploaded a profile image for a specified user

Operation ID:
UsersUploadImage

Uploaded a profile image for a specified user.

Parameters

Name Key Required Type Description
User ID
 userId True string

Id of the user.

Validate a time slots of a pattern

Operation ID:
TeamsValidateAlertPattern

Validate a time slots of a pattern against all existing time slots of other patterns.

Parameters

Name Key Required Type Description
Team ID
 teamId True string

Team ID of alerting pattern
Pattern ID
 patternId string

Alerting pattern ID of pattern you want to save time slots for. Can be null
Category IDs
 categoryIds array

Category IDs of the pattern you want to validate. Can be null.
hour
 hour integer
minutes
 minutes integer
weekday
 weekday integer

  • 0 = Holiday
  • 1 = Monday
  • 2 = Tuesday
  • 3 = Wednesday
  • 4 = Thursday
  • 5 = Friday
  • 6 = Saturday
  • 7 = Sunday
id
 id string

Returns

response
array of V2.TimeSlotValidationResultDetails

Validates a previous created phone number for a user

Operation ID:
UsersValidatePhoneNumber

Validates a previous created phone number for a user.

Parameters

Name Key Required Type Description
User ID
 userId True string

User Id of user you want to validate previous created phone number
phoneNumber
 phoneNumber string
validationCode
 validationCode string

Withdraw closure of multiple alerts

Operation ID:
AlertsUndoCloseMultiple

This method tries to undo multiple alert closes. The operation is handled in the background.

Parameters

Name Key Required Type Description
alertIds
 alertIds True array of string
descr
 descr string
uid
 uid True string

Definitions

AlertAuditReportFileInfo

Name Path Type Description
fileName
 fileName string
fileSizeInBytes
 fileSizeInBytes integer
lastRecord
 lastRecord date-time
lastUpdated
 lastUpdated date-time
month
 month integer
year
 year integer

AlertEscalationModes

  • 0 = Manager
  • 1 = Team

  • 0 = Manager
  • 1 = Team
integer

AlertFilterActions

  • 0 = Suppress
  • 1 = Hide
  • 2 = Mute

  • 0 = Suppress
  • 1 = Hide
  • 2 = Mute
integer

AlertFilterModes

  • 0 = Off
  • 1 = WhiteListAllCategories

  • 0 = Off
  • 1 = WhiteListAllCategories
integer

AlertNotificationInfo

Name Path Type Description
address
 address string
deviceName
 deviceName string
lastUpdate
 lastUpdate date-time
messageStatus
 messageStatus AlertNotificationInfoMessageStatus

  • 0 = None
  • 1 = Rejected
  • 2 = Failed
  • 3 = Queued
  • 4 = Transmitted
  • 5 = Buffered
  • 6 = Delivered
  • 7 = Canceled
  • 8 = Protected
  • 9 = AbuseProtected
  • 10 = Delayed
messageStatusErrorCode
 messageStatusErrorCode integer
notificationChannelType
 notificationChannelType AlertNotificationInfoChannelType

  • 0 = None
  • 1 = Push
  • 2 = Email
  • 4 = Bot
  • 8 = Voice
  • 16 = SMS
userId
 userId string
userStatus
 userStatus AlertNotificationInfoUserStatus

  • 0 = None
  • 1 = MessageCreated
  • 2 = NotOnDuty
  • 3 = CategoryHidden
  • 4 = CategoryMuted
  • 5 = NoNotificationProfiles
  • 6 = NoMessagesByNotificationProfiles

AlertNotificationInfoChannelType

  • 0 = None
  • 1 = Push
  • 2 = Email
  • 4 = Bot
  • 8 = Voice
  • 16 = SMS

  • 0 = None
  • 1 = Push
  • 2 = Email
  • 4 = Bot
  • 8 = Voice
  • 16 = SMS
integer

AlertNotificationInfoMessageStatus

  • 0 = None
  • 1 = Rejected
  • 2 = Failed
  • 3 = Queued
  • 4 = Transmitted
  • 5 = Buffered
  • 6 = Delivered
  • 7 = Canceled
  • 8 = Protected
  • 9 = AbuseProtected
  • 10 = Delayed

  • 0 = None
  • 1 = Rejected
  • 2 = Failed
  • 3 = Queued
  • 4 = Transmitted
  • 5 = Buffered
  • 6 = Delivered
  • 7 = Canceled
  • 8 = Protected
  • 9 = AbuseProtected
  • 10 = Delayed
integer

AlertNotificationInfoUserStatus

  • 0 = None
  • 1 = MessageCreated
  • 2 = NotOnDuty
  • 3 = CategoryHidden
  • 4 = CategoryMuted
  • 5 = NoNotificationProfiles
  • 6 = NoMessagesByNotificationProfiles

  • 0 = None
  • 1 = MessageCreated
  • 2 = NotOnDuty
  • 3 = CategoryHidden
  • 4 = CategoryMuted
  • 5 = NoNotificationProfiles
  • 6 = NoMessagesByNotificationProfiles
integer

AlertResponseModes

  • 2 = SingleAcknowledge
  • 4 = MultiAcknowledge

  • 2 = SingleAcknowledge
  • 4 = MultiAcknowledge
integer

AlertSettings

Name Path Type Description
escEnabled
 escEnabled boolean
escMode
 escMode AlertEscalationModes

  • 0 = Manager
  • 1 = Team
escRefId
 escRefId string
filterAction
 filterAction AlertFilterActions

  • 0 = Suppress
  • 1 = Hide
  • 2 = Mute
filterMode
 filterMode AlertFilterModes

  • 0 = Off
  • 1 = WhiteListAllCategories
notificationProfileOverrides
 notificationProfileOverrides array of AlertSettingsNotificationProfile
optOut
 optOut TeamCategoryOptOutModes

  • 0 = None
  • 1 = Disabled
  • 2 = Personal
overrideNotificationProfiles
 overrideNotificationProfiles boolean
persNotInterval
 persNotInterval integer
persNotMode
 persNotMode PersistentNotificationModes

  • 0 = Off
  • 1 = Summary
responseMode
 responseMode AlertResponseModes

  • 2 = SingleAcknowledge
  • 4 = MultiAcknowledge
responseTime
 responseTime integer

AlertSettingsChannelType

  • 0 = None
  • 1 = Push
  • 2 = Voice
  • 3 = SMS

  • 0 = None
  • 1 = Push
  • 2 = Voice
  • 3 = SMS
integer

AlertSettingsNotificationProfile

Name Path Type Description
channel
 channel AlertSettingsChannelType

  • 0 = None
  • 1 = Push
  • 2 = Voice
  • 3 = SMS
delay
 delay integer
enabled
 enabled boolean

CategoryAugmentation

Name Path Type Description
enabled
 enabled boolean
id
 id string
name
 name string
type
 type CategoryAugmentationType

  • 0 = Parameter
  • 1 = Subject
  • 2 = Text
  • 3 = Location
value
 value string

CategoryAugmentationType

  • 0 = Parameter
  • 1 = Subject
  • 2 = Text
  • 3 = Location

  • 0 = Parameter
  • 1 = Subject
  • 2 = Text
  • 3 = Location
integer

CategoryEnrichment

Name Path Type Description
id
 id string
name
 name string
type
 type CategoryEnrichmentType

  • 0 = Parameter
  • 1 = Hyperlink
value
 value string

CategoryEnrichmentType

  • 0 = Parameter
  • 1 = Hyperlink

  • 0 = Parameter
  • 1 = Hyperlink
integer

CategoryInfo

Name Path Type Description
augmentations
 augmentations array of CategoryAugmentation
color
 color string
enrichments
 enrichments array of CategoryEnrichment
id
 id string
imageName
 imageName string
isDefault
 isDefault boolean
keywordMatching
 keywordMatching KeywordMatchingType

  • 0 = Any
  • 1 = All
keywords
 keywords array of string
keywordsExcluded
 keywordsExcluded array of string
name
 name string
options
 options CategoryInfoOptions

  • 0 = None
  • 1 = Hidden
  • 2 = DenyDelete
  • 4 = HideOptOut
  • 8 = HideKeywords
order
 order integer
teamId
 teamId string

CategoryInfoOptions

  • 0 = None
  • 1 = Hidden
  • 2 = DenyDelete
  • 4 = HideOptOut
  • 8 = HideKeywords

  • 0 = None
  • 1 = Hidden
  • 2 = DenyDelete
  • 4 = HideOptOut
  • 8 = HideKeywords
integer

CategoryMetrics

Name Path Type Description
categoryId
 categoryId string
last24h
 last24h integer
lastAlert
 lastAlert date-time
subscriberCount
 subscriberCount integer

CategorySubscriptionInfo

Name Path Type Description
status
 status CategorySubscriptionStatus

  • 0 = Subscribed
  • 1 = Muted
  • 2 = Hidden
userId
 userId string

CategorySubscriptionStatus

  • 0 = Subscribed
  • 1 = Muted
  • 2 = Hidden

  • 0 = Subscribed
  • 1 = Muted
  • 2 = Hidden
integer

ChannelPriceInfo

Name Path Type Description
sms
 sms integer
voicePerMinute
 voicePerMinute integer

DutySummaryInfo

Name Path Type Description
dutyEnd
 dutyEnd date-time
dutyId
 dutyId string
dutyStart
 dutyStart date-time

EventParameterInfo

Name Path Type Description
name
 name string
order
 order integer
type
 type EventParameterTypes

  • 0 = None
  • 1 = Object
  • 2 = Array
  • 3 = Constructor
  • 4 = Property
  • 5 = Comment
  • 6 = Integer
  • 7 = Float
  • 8 = String
  • 9 = Boolean
  • 10 = Null
  • 11 = Undefined
  • 12 = Date
  • 13 = Raw
  • 14 = Bytes
  • 15 = Guid
  • 16 = Uri
  • 17 = TimeSpan
  • 100 = Html
value
 value string

EventParameterTypes

  • 0 = None
  • 1 = Object
  • 2 = Array
  • 3 = Constructor
  • 4 = Property
  • 5 = Comment
  • 6 = Integer
  • 7 = Float
  • 8 = String
  • 9 = Boolean
  • 10 = Null
  • 11 = Undefined
  • 12 = Date
  • 13 = Raw
  • 14 = Bytes
  • 15 = Guid
  • 16 = Uri
  • 17 = TimeSpan
  • 100 = Html

  • 0 = None
  • 1 = Object
  • 2 = Array
  • 3 = Constructor
  • 4 = Property
  • 5 = Comment
  • 6 = Integer
  • 7 = Float
  • 8 = String
  • 9 = Boolean
  • 10 = Null
  • 11 = Undefined
  • 12 = Date
  • 13 = Raw
  • 14 = Bytes
  • 15 = Guid
  • 16 = Uri
  • 17 = TimeSpan
  • 100 = Html
integer

EventSeverities

  • 0 = Low
  • 1 = Major
  • 2 = Critical

  • 0 = Low
  • 1 = Major
  • 2 = Critical
integer

EventSourceEndpointInfo

Name Path Type Description
address
 address string
description
 description string
disabled
 disabled boolean
groupId
 groupId string
id
 id string
lastEvent
 lastEvent date-time
name
 name string
subType
 subType string
subscriptionId
 subscriptionId string
teamId
 teamId string
type
 type EventSourceTypes

  • 0 = None
  • 1 = Email
  • 2 = WebHook
  • 3 = Script
  • 4 = System
  • 5 = Manual
  • 6 = Voice
  • 7 = Api

EventSourceTypes

  • 0 = None
  • 1 = Email
  • 2 = WebHook
  • 3 = Script
  • 4 = System
  • 5 = Manual
  • 6 = Voice
  • 7 = Api

  • 0 = None
  • 1 = Email
  • 2 = WebHook
  • 3 = Script
  • 4 = System
  • 5 = Manual
  • 6 = Voice
  • 7 = Api
integer

EventStatusCodes

  • 0 = None
  • 1 = Processing
  • 2 = Signled
  • 3 = Filtered
  • 4 = Resolved
  • 5 = Discarded
  • 6 = Acknowledged
  • 7 = Suppressed
  • 8 = NoRuleApplied
  • 9 = MultipleTargetStatus
  • 1000 = Error

  • 0 = None
  • 1 = Processing
  • 2 = Signled
  • 3 = Filtered
  • 4 = Resolved
  • 5 = Discarded
  • 6 = Acknowledged
  • 7 = Suppressed
  • 8 = NoRuleApplied
  • 9 = MultipleTargetStatus
  • 1000 = Error
integer

InventoryScriptInfo

Name Path Type Description
config
 config
data
 data ScriptDescriptionData
eventPattern
 eventPattern
localizationDetails
 localizationDetails array of ScriptLocalizationDetail
scriptId
 scriptId string
scriptName
 scriptName string
visibility
 visibility string

KeywordMatchingType

  • 0 = Any
  • 1 = All

  • 0 = Any
  • 1 = All
integer

LocationInfo

Name Path Type Description
latitude
 latitude double
longitude
 longitude double
timestamp
 timestamp date-time

MultiTeamResult-2-EventSourceEndpointInfo-V2.EventSourceEndpointError-

Name Path Type Description
data
 data array of EventSourceEndpointInfo
errors
 errors array of V2.EventSourceEndpointError

MultiTeamResult-2-TeamDutySummaryInfo-V2.TeamDutySummaryError-

Name Path Type Description
data
 data array of TeamDutySummaryInfo
errors
 errors array of V2.TeamDutySummaryError

MultiTeamResult-2-UserDutyInfo-V2.DutyError-

Name Path Type Description
data
 data array of UserDutyInfo
errors
 errors array of V2.DutyError

MultiTeamResult-2-V2.AlertCountsDetails-V2.AlertReportError-

Name Path Type Description
data
 data array of V2.AlertCountsDetails
errors
 errors array of V2.AlertReportError

MultiTeamResult-2-V2.AlertSettingsDetails-V2.AlertSettingsError-

Name Path Type Description
data
 data array of V2.AlertSettingsDetails
errors
 errors array of V2.AlertSettingsError

MultiTeamResult-2-V2.CategoryDetails-V2.CategoryError-

Name Path Type Description
data
 data array of V2.CategoryDetails
errors
 errors array of V2.CategoryError

MultiTeamResult-2-V2.TeamDutySettingsDetails-V2.TeamDutySettingsError-

Name Path Type Description
data
 data array of V2.TeamDutySettingsDetails
errors
 errors array of V2.TeamDutySettingsError

MultiTeamResult-2-V2.TeamPermissions-V2.PermissionError-

Name Path Type Description
data
 data array of V2.TeamPermissions
errors
 errors array of V2.PermissionError

MultiTeamResult-2-V2.UserDetails-V2.TeamUserError-

Name Path Type Description
data
 data array of V2.UserDetails
errors
 errors array of V2.TeamUserError

MultiTeamResult-2-V2.UserDutyDetails-V2.DutyChangeError-

Name Path Type Description
data
 data array of V2.UserDutyDetails
errors
 errors array of V2.DutyChangeError

OverviewEvent

Name Path Type Description
acknowledgedAlerts
 acknowledgedAlerts array of string
alertId
 alertId string
categoryId
 categoryId string
closedAlerts
 closedAlerts array of string
creationTime
 creationTime date-time
eventSourceGroupId
 eventSourceGroupId string
eventSourceId
 eventSourceId string
eventSourceTeamId
 eventSourceTeamId string
eventSourceType
 eventSourceType EventSourceTypes

  • 0 = None
  • 1 = Email
  • 2 = WebHook
  • 3 = Script
  • 4 = System
  • 5 = Manual
  • 6 = Voice
  • 7 = Api
eventStatus
 eventStatus EventStatusCodes

  • 0 = None
  • 1 = Processing
  • 2 = Signled
  • 3 = Filtered
  • 4 = Resolved
  • 5 = Discarded
  • 6 = Acknowledged
  • 7 = Suppressed
  • 8 = NoRuleApplied
  • 9 = MultipleTargetStatus
  • 1000 = Error
id
 id string
lastModified
 lastModified date-time
severity
 severity EventSeverities

  • 0 = Low
  • 1 = Major
  • 2 = Critical
teamId
 teamId string
text
 text string
title
 title string

PagedResultsPublicContinuationToken

Name Path Type Description
nextPartitionKey
 nextPartitionKey string
nextRowKey
 nextRowKey string
nextTableName
 nextTableName string

PagedResultsPublic-1-OverviewEvent-

Name Path Type Description
continuationToken
 continuationToken PagedResultsPublicContinuationToken
hasMore
 hasMore boolean
results
 results array of OverviewEvent

PagedResultsPublic-1-V2.AlertInfo-

Name Path Type Description
continuationToken
 continuationToken PagedResultsPublicContinuationToken
hasMore
 hasMore boolean
results
 results array of V2.AlertInfo

PagedResultsPublic-1-V2.RemoteJob-

Name Path Type Description
continuationToken
 continuationToken PagedResultsPublicContinuationToken
hasMore
 hasMore boolean
results
 results array of V2.RemoteJob

PersistentNotificationModes

  • 0 = Off
  • 1 = Summary

  • 0 = Off
  • 1 = Summary
integer

PrepaidBalanceInfo

Name Path Type Description
balance
 balance integer
latestTopUp
 latestTopUp date-time
pendingTransactions
 pendingTransactions boolean

PrepaidSettingsInfo

Name Path Type Description
topUpAmount
 topUpAmount integer
topUpEnabled
 topUpEnabled boolean
topUpLimit
 topUpLimit integer

PrepaidTransactionInfo

Name Path Type Description
amount
 amount integer
autoTopUpId
 autoTopUpId string
created
 created date-time
createdBy
 createdBy string
currency
 currency string
modified
 modified date-time
packageCode
 packageCode string
status
 status string
statusCode
 statusCode integer
subscriptionId
 subscriptionId string
transactionId
 transactionId string

ScheduleInfo

Name Path Type Description
end
 end date-time
id
 id string
options
 options integer
start
 start date-time
userId
 userId string

ScriptDescriptionData

Name Path Type Description
description
 description string
name
 name string
scriptType
 scriptType string
shortDescription
 shortDescription string

ScriptInstanceDetails

Name Path Type Description
config
 config
customScriptDescription
 customScriptDescription string
customScriptName
 customScriptName string
enabled
 enabled boolean
eventPattern
 eventPattern
eventSourceId
 eventSourceId string
instanceId
 instanceId string
lastModified
 lastModified date-time
runtimeInformation
 runtimeInformation ScriptInstanceInfoRuntimeInformationModel
scriptId
 scriptId string
scriptName
 scriptName string
subscriptionId
 subscriptionId string
teamId
 teamId string
webhookUrl
 webhookUrl string

ScriptInstanceInfo

Name Path Type Description
customScriptDescription
 customScriptDescription string
customScriptName
 customScriptName string
enabled
 enabled boolean
eventPattern
 eventPattern
eventSourceId
 eventSourceId string
instanceId
 instanceId string
lastModified
 lastModified date-time
runtimeInformation
 runtimeInformation ScriptInstanceInfoRuntimeInformationModel
scriptId
 scriptId string
scriptName
 scriptName string
subscriptionId
 subscriptionId string
teamId
 teamId string

ScriptInstanceInfoRuntimeInformationModel

Name Path Type Description
runtimeStatus
 runtimeStatus ScriptInstanceInfoRuntimeStatus

  • 0 = Unknown
  • 1 = Starting
  • 2 = OK
  • 3 = Stopping
  • 4 = Stopped
  • -1 = Error
runtimeStatusMessage
 runtimeStatusMessage string

ScriptInstanceInfoRuntimeStatus

  • 0 = Unknown
  • 1 = Starting
  • 2 = OK
  • 3 = Stopping
  • 4 = Stopped
  • -1 = Error

  • 0 = Unknown
  • 1 = Starting
  • 2 = OK
  • 3 = Stopping
  • 4 = Stopped
  • -1 = Error
integer

ScriptLocalizationDetail

Name Path Type Description
config
 config
data
 data ScriptDescriptionData
language
 language string

SubscriptionFeature

Name Path Type Description
name
 name string
type
 type integer
value
 value string

SubscriptionInfo

Name Path Type Description
branchId
 branchId string
country
 country string
currency
 currency string
externalAccountId
 externalAccountId string
id
 id string
name
 name string
nextBilling
 nextBilling date-time
ownerId
 ownerId string
planCode
 planCode string
planState
 planState integer
referralEnabled
 referralEnabled boolean
status
 status integer

TeamCategoryOptOutModes

  • 0 = None
  • 1 = Disabled
  • 2 = Personal

  • 0 = None
  • 1 = Disabled
  • 2 = Personal
integer

TeamDutySummaryInfo

Name Path Type Description
dutyAssistEnabled
 dutyAssistEnabled boolean
dutySummaries
 dutySummaries array of DutySummaryInfo
teamId
 teamId string

TeamInfo

Name Path Type Description
id
 id string
imageLastModified
 imageLastModified date-time
memberIds
 memberIds array of string
name
 name string
setupProgressEnabled
 setupProgressEnabled boolean
subscriptionId
 subscriptionId string
timezone
 timezone string

TeamSetupProgress

Name Path Type Description
completedSteps
 completedSteps array of string
teamId
 teamId string
timestamp
 timestamp date-time

UserDutyInfo

Name Path Type Description
lastChange
 lastChange date-time
onDuty
 onDuty boolean
onManagerDuty
 onManagerDuty boolean
overdue
 overdue boolean
teamId
 teamId string
userId
 userId string

UserImage

Name Path Type Description
content
 content byte
contentDispostion
 contentDispostion string
contentEncoding
 contentEncoding string
contentType
 contentType string
lastModified
 lastModified date-time
name
 name string

UserInfo

Name Path Type Description
colorIndex
 colorIndex integer
contactAddresses
 contactAddresses array of
dutyInfos
 dutyInfos UserDutyInfo
externalAuthProvider
 externalAuthProvider string
id
 id string
isDeactivated
 isDeactivated boolean
isInvite
 isInvite boolean
isRemoteActionPinSet
 isRemoteActionPinSet boolean
lastSeen
 lastSeen date-time
mail
 mail string
name
 name string
roleId
 roleId string
subscriptionId
 subscriptionId string
timeZone
 timeZone string
userImageLastModified
 userImageLastModified date-time

UserLicenseInfo

Name Path Type Description
currentUsers
 currentUsers integer
isFree
 isFree boolean
isTrial
 isTrial boolean
licensedUsers
 licensedUsers integer
planCode
 planCode string

UserPermission

Name Path Type Description
allowed
 allowed boolean
permission
 permission string

UserSetupProgress

Name Path Type Description
completedSteps
 completedSteps array of string
timestamp
 timestamp date-time
userId
 userId string

V2.AlertAnnotationDetails

Name Path Type Description
id
 id string
teamId
 teamId string
text
 text string
timestamp
 timestamp date-time
type
 type V2.AlertAnnotationTypes

  • 0 = None
  • 1 = Text
  • 2 = Image
userId
 userId string

V2.AlertAnnotationTypes

  • 0 = None
  • 1 = Text
  • 2 = Image

  • 0 = None
  • 1 = Text
  • 2 = Image
integer

V2.AlertAttachmentInfo

Name Path Type Description
contentType
 contentType string
id
 id string
name
 name string

V2.AlertCategoryCountsDetails

Name Path Type Description
acknowledged
 acknowledged integer
categoryId
 categoryId string
closed
 closed integer
unhandled
 unhandled integer

V2.AlertCountTypes

  • 1 = TeamCurrentDuty
  • 2 = TeamLastDuty
  • 3 = UserLastDutyChange
  • 4 = Last24Hours

  • 1 = TeamCurrentDuty
  • 2 = TeamLastDuty
  • 3 = UserLastDutyChange
  • 4 = Last24Hours
integer

V2.AlertCountsDetails

Name Path Type Description
acknowledged
 acknowledged integer
categoryCounts
 categoryCounts array of V2.AlertCategoryCountsDetails
closed
 closed integer
end
 end date-time
lastModified
 lastModified date-time
start
 start date-time
subscriptionId
 subscriptionId string
teamId
 teamId string
type
 type V2.AlertCountTypes

  • 1 = TeamCurrentDuty
  • 2 = TeamLastDuty
  • 3 = UserLastDutyChange
  • 4 = Last24Hours
typeString
 typeString string
unhandled
 unhandled integer
userId
 userId string

V2.AlertDeliveryStatusCodes

  • 0 = None
  • 1 = Open
  • 2 = Failed
  • 4 = Transmitted
  • 6 = Delivered
  • 8 = Protected
  • 9 = AbuseProtected
  • 22 = PartlyFailed
  • 24 = PartlyTransmitted
  • 26 = PartlyDelivered
  • 30 = NoOneOnDuty
  • 31 = NoOneNotified

  • 0 = None
  • 1 = Open
  • 2 = Failed
  • 4 = Transmitted
  • 6 = Delivered
  • 8 = Protected
  • 9 = AbuseProtected
  • 22 = PartlyFailed
  • 24 = PartlyTransmitted
  • 26 = PartlyDelivered
  • 30 = NoOneOnDuty
  • 31 = NoOneNotified
integer

V2.AlertDeliveryStatusDetails

Name Path Type Description
alertId
 alertId string
statusCode
 statusCode V2.AlertDeliveryStatusCodes

  • 0 = None
  • 1 = Open
  • 2 = Failed
  • 4 = Transmitted
  • 6 = Delivered
  • 8 = Protected
  • 9 = AbuseProtected
  • 22 = PartlyFailed
  • 24 = PartlyTransmitted
  • 26 = PartlyDelivered
  • 30 = NoOneOnDuty
  • 31 = NoOneNotified
userDeliveryStatus
 userDeliveryStatus array of V2.UserDeliveryStatus

V2.AlertDetails

Name Path Type Description
parameters
 parameters array of V2.EventParameterDetails
attachments
 attachments array of V2.AlertAttachmentInfo
categoryId
 categoryId string
escalations
 escalations array of V2.AlertEscalationDetails
eventId
 eventId string
externalId
 externalId string
flags
 flags V2.AlertFlags

  • 0 = None
  • 1 = HasAttachments
  • 2 = HasAnnotations
  • 4 = IsBreached
  • 8 = HasLocationInfo
  • 16 = EscalatedToTeam
  • 32 = EscalatedToManager
  • 64 = CreatedByEscalation
history
 history V2.AlertHistoryInfo
id
 id string
lastModified
 lastModified date-time
requiredAcknowledgements
 requiredAcknowledgements integer
severity
 severity V2.AlertSeverities

  • 0 = Low
  • 1 = Major
  • 2 = Critical
status
 status V2.AlertStatusDetails
subscriptionId
 subscriptionId string
teamId
 teamId string
text
 text string
timelineEntries
 timelineEntries array of
title
 title string
workflowType
 workflowType V2.AlertWorkflowTypes

  • 0 = None
  • 1 = User
  • 2 = TeamBroadcast
  • 3 = TeamEscalation
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency

V2.AlertEscalationDetails

Name Path Type Description
alertId
 alertId string
alertStatus
 alertStatus V2.AlertStatusCodes

  • 0 = None
  • 1 = Open
  • 2 = Acknowledged
  • 4 = Closed
  • 8 = NoReply
  • 16 = Failed
  • 32 = Error
escType
 escType V2.AlertEscalationType

  • 0 = None
  • 1 = Manager
  • 2 = Team
status
 status V2.AlertEscalationStatus

  • 0 = Ok
  • 1 = InProgress
  • 2 = TargetInvalid
  • 3 = TargetPrivate
  • 4 = Filtered
  • 5 = Suppressed
teamId
 teamId string
teamName
 teamName string
timestamp
 timestamp date-time

V2.AlertEscalationStatus

  • 0 = Ok
  • 1 = InProgress
  • 2 = TargetInvalid
  • 3 = TargetPrivate
  • 4 = Filtered
  • 5 = Suppressed

  • 0 = Ok
  • 1 = InProgress
  • 2 = TargetInvalid
  • 3 = TargetPrivate
  • 4 = Filtered
  • 5 = Suppressed
integer

V2.AlertEscalationType

  • 0 = None
  • 1 = Manager
  • 2 = Team

  • 0 = None
  • 1 = Manager
  • 2 = Team
integer

V2.AlertFlags

  • 0 = None
  • 1 = HasAttachments
  • 2 = HasAnnotations
  • 4 = IsBreached
  • 8 = HasLocationInfo
  • 16 = EscalatedToTeam
  • 32 = EscalatedToManager
  • 64 = CreatedByEscalation

  • 0 = None
  • 1 = HasAttachments
  • 2 = HasAnnotations
  • 4 = IsBreached
  • 8 = HasLocationInfo
  • 16 = EscalatedToTeam
  • 32 = EscalatedToManager
  • 64 = CreatedByEscalation
integer

V2.AlertHistoryInfo

Name Path Type Description
acknowledgedAt
 acknowledgedAt date-time
acknowledgements
 acknowledgements array of string
closedAt
 closedAt date-time
closedBy
 closedBy string
created
 created date-time

V2.AlertInfo

Name Path Type Description
categoryId
 categoryId string
eventId
 eventId string
externalId
 externalId string
flags
 flags V2.AlertFlags

  • 0 = None
  • 1 = HasAttachments
  • 2 = HasAnnotations
  • 4 = IsBreached
  • 8 = HasLocationInfo
  • 16 = EscalatedToTeam
  • 32 = EscalatedToManager
  • 64 = CreatedByEscalation
history
 history V2.AlertHistoryInfo
id
 id string
lastModified
 lastModified date-time
requiredAcknowledgements
 requiredAcknowledgements integer
severity
 severity V2.AlertSeverities

  • 0 = Low
  • 1 = Major
  • 2 = Critical
status
 status V2.AlertStatusDetails
subscriptionId
 subscriptionId string
teamId
 teamId string
text
 text string
title
 title string
workflowType
 workflowType V2.AlertWorkflowTypes

  • 0 = None
  • 1 = User
  • 2 = TeamBroadcast
  • 3 = TeamEscalation
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency

V2.AlertReportError

Name Path Type Description
errorCode
 errorCode integer
errorDescription
 errorDescription string
teamId
 teamId string

V2.AlertSettingsChannelType

  • 0 = None
  • 1 = Push
  • 2 = Voice
  • 3 = SMS

  • 0 = None
  • 1 = Push
  • 2 = Voice
  • 3 = SMS
integer

V2.AlertSettingsDetails

Name Path Type Description
escEnabled
 escEnabled boolean
escMode
 escMode AlertEscalationModes

  • 0 = Manager
  • 1 = Team
escRefId
 escRefId string
filterAction
 filterAction AlertFilterActions

  • 0 = Suppress
  • 1 = Hide
  • 2 = Mute
filterMode
 filterMode AlertFilterModes

  • 0 = Off
  • 1 = WhiteListAllCategories
notificationProfileOverrides
 notificationProfileOverrides array of V2.AlertSettingsNotificationProfileDetails
optOut
 optOut TeamCategoryOptOutModes

  • 0 = None
  • 1 = Disabled
  • 2 = Personal
overrideNotificationProfiles
 overrideNotificationProfiles boolean
persNotInterval
 persNotInterval integer
persNotMode
 persNotMode PersistentNotificationModes

  • 0 = Off
  • 1 = Summary
responseMode
 responseMode AlertResponseModes

  • 2 = SingleAcknowledge
  • 4 = MultiAcknowledge
responseTime
 responseTime integer
teamId
 teamId string

V2.AlertSettingsError

Name Path Type Description
errorCode
 errorCode integer
errorDescription
 errorDescription string
teamId
 teamId string

V2.AlertSettingsNotificationProfileDetails

Name Path Type Description
channel
 channel V2.AlertSettingsChannelType

  • 0 = None
  • 1 = Push
  • 2 = Voice
  • 3 = SMS
delayInMinutes
 delayInMinutes integer
enabled
 enabled boolean

V2.AlertSeverities

  • 0 = Low
  • 1 = Major
  • 2 = Critical

  • 0 = Low
  • 1 = Major
  • 2 = Critical
integer

V2.AlertStatusCodes

  • 0 = None
  • 1 = Open
  • 2 = Acknowledged
  • 4 = Closed
  • 8 = NoReply
  • 16 = Failed
  • 32 = Error

  • 0 = None
  • 1 = Open
  • 2 = Acknowledged
  • 4 = Closed
  • 8 = NoReply
  • 16 = Failed
  • 32 = Error
integer

V2.AlertStatusDetails

Name Path Type Description
alertDeliveryStatus
 alertDeliveryStatus V2.AlertDeliveryStatusDetails
statusCode
 statusCode V2.AlertStatusCodes

  • 0 = None
  • 1 = Open
  • 2 = Acknowledged
  • 4 = Closed
  • 8 = NoReply
  • 16 = Failed
  • 32 = Error

V2.AlertWorkflowTypes

  • 0 = None
  • 1 = User
  • 2 = TeamBroadcast
  • 3 = TeamEscalation
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency

  • 0 = None
  • 1 = User
  • 2 = TeamBroadcast
  • 3 = TeamEscalation
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency
integer

V2.AlertingPatternChannelType

  • 0 = None
  • 1 = Push
  • 2 = Voice
  • 3 = SMS

  • 0 = None
  • 1 = Push
  • 2 = Voice
  • 3 = SMS
integer

V2.AlertingPatternDetails

Name Path Type Description
categories
 categories array of string
escalationSettings
 escalationSettings V2.AlertingPatternEscalationSettings
id
 id string
name
 name string
notificationProfileOverrides
 notificationProfileOverrides array of V2.AlertingPatternNotificationProfileDetails
overrideEscalationSettings
 overrideEscalationSettings boolean
overrideNotificationProfiles
 overrideNotificationProfiles boolean
overrideResponseSettings
 overrideResponseSettings boolean
responseSettings
 responseSettings V2.AlertingPatternResponseSettings
suppressSignl
 suppressSignl boolean
timeSlots
 timeSlots array of V2.TimeSlotDetails

V2.AlertingPatternEscalationSettings

Name Path Type Description
enabled
 enabled boolean
mode
 mode AlertEscalationModes

  • 0 = Manager
  • 1 = Team
referenceId
 referenceId string

V2.AlertingPatternNotificationProfileDetails

Name Path Type Description
channel
 channel V2.AlertingPatternChannelType

  • 0 = None
  • 1 = Push
  • 2 = Voice
  • 3 = SMS
delayInMinutes
 delayInMinutes integer
enabled
 enabled boolean

V2.AlertingPatternResponseSettings

Name Path Type Description
responseMode
 responseMode AlertResponseModes

  • 2 = SingleAcknowledge
  • 4 = MultiAcknowledge
responseTime
 responseTime integer

V2.CalloutTemplateDetails

Name Path Type Description
categoryId
 categoryId string
externalId
 externalId string
id
 id string
location
 location string
name
 name string
subject
 subject string
targetAllTeams
 targetAllTeams boolean
targetTeamId
 targetTeamId string
text
 text string
workflowType
 workflowType V2.CalloutTemplateWorkflowType

  • 0 = AsConfiguredInTeam
  • 2 = TeamBroadcast
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency

V2.CalloutTemplateWorkflowType

  • 0 = AsConfiguredInTeam
  • 2 = TeamBroadcast
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency

  • 0 = AsConfiguredInTeam
  • 2 = TeamBroadcast
  • 4 = MultiAcknowledge
  • 5 = MultiAcknowledgeEmergency
integer

V2.CategoryAugmentationDetails

Name Path Type Description
enabled
 enabled boolean
id
 id string
name
 name string
type
 type V2.CategoryAugmentationType

  • 0 = Parameter
  • 1 = Subject
  • 2 = Text
  • 3 = Location
value
 value string

V2.CategoryAugmentationType

  • 0 = Parameter
  • 1 = Subject
  • 2 = Text
  • 3 = Location

  • 0 = Parameter
  • 1 = Subject
  • 2 = Text
  • 3 = Location
integer

V2.CategoryDetails

Name Path Type Description
augmentations
 augmentations array of V2.CategoryAugmentationDetails
color
 color string
enrichments
 enrichments array of V2.CategoryEnrichmentDetails
id
 id string
imageName
 imageName string
isDefault
 isDefault boolean
keywordMatching
 keywordMatching V2.KeywordMatchingType

  • 0 = Any
  • 1 = All
keywords
 keywords array of string
keywordsExcluded
 keywordsExcluded array of string
name
 name string
options
 options V2.CategoryOptions

  • 0 = None
  • 1 = Hidden
  • 2 = DenyDelete
  • 4 = HideOptOut
  • 8 = HideKeywords
order
 order integer
teamId
 teamId string

V2.CategoryEnrichmentDetails

Name Path Type Description
id
 id string
name
 name string
type
 type V2.CategoryEnrichmentType

  • 0 = Parameter
  • 1 = Hyperlink
value
 value string

V2.CategoryEnrichmentType

  • 0 = Parameter
  • 1 = Hyperlink

  • 0 = Parameter
  • 1 = Hyperlink
integer

V2.CategoryError

Name Path Type Description
errorCode
 errorCode integer
errorDescription
 errorDescription string
teamId
 teamId string

V2.CategoryOptions

  • 0 = None
  • 1 = Hidden
  • 2 = DenyDelete
  • 4 = HideOptOut
  • 8 = HideKeywords

  • 0 = None
  • 1 = Hidden
  • 2 = DenyDelete
  • 4 = HideOptOut
  • 8 = HideKeywords
integer

V2.ChannelType

  • 0 = None
  • 1 = Push
  • 2 = Email
  • 4 = Bot
  • 8 = Voice
  • 16 = SMS

  • 0 = None
  • 1 = Push
  • 2 = Email
  • 4 = Bot
  • 8 = Voice
  • 16 = SMS
integer

V2.DutyChangeError

Name Path Type Description
errorCode
 errorCode integer
errorDescription
 errorDescription string
teamId
 teamId string
userId
 userId string

V2.DutyError

Name Path Type Description
errorCode
 errorCode integer
errorDescription
 errorDescription string
teamId
 teamId string

V2.DutyModes

  • 0 = None
  • 1 = Primary
  • 100 = Manager

  • 0 = None
  • 1 = Primary
  • 100 = Manager
integer

V2.EventDetails

Name Path Type Description
parameters
 parameters array of V2.EventParameterDetails
acknowledgedAlerts
 acknowledgedAlerts array of string
closedAlerts
 closedAlerts array of string
creationTime
 creationTime date-time
eventSourceGroupId
 eventSourceGroupId string
eventSourceId
 eventSourceId string
eventSourceTeamId
 eventSourceTeamId string
eventSourceType
 eventSourceType V2.EventSourceTypes

  • 0 = None
  • 1 = Email
  • 2 = WebHook
  • 3 = Script
  • 4 = System
  • 5 = Manual
  • 6 = Voice
  • 7 = Api
eventStatus
 eventStatus V2.EventStatusCodes

  • 0 = None
  • 1 = Processing
  • 2 = Signled
  • 3 = Filtered
  • 4 = Resolved
  • 5 = Discarded
  • 6 = Acknowledged
  • 7 = Suppressed
  • 8 = NoRuleApplied
  • 9 = MultipleTargetStatus
  • 1000 = Error
externalId
 externalId string
from
 from string
id
 id string
lastModified
 lastModified date-time
severity
 severity V2.EventSeverities

  • 0 = Low
  • 1 = Major
  • 2 = Critical
targets
 targets array of V2.EventTargetDetails
text
 text string
title
 title string

V2.EventParameterDetails

Name Path Type Description
id
 id string
name
 name string
options
 options V2.EventParameterOptions

  • 0 = None
  • 1 = ExcludeFromCategorization
order
 order integer
type
 type V2.EventParameterTypes

  • 0 = None
  • 1 = Object
  • 2 = Array
  • 3 = Constructor
  • 4 = Property
  • 5 = Comment
  • 6 = Integer
  • 7 = Float
  • 8 = String
  • 9 = Boolean
  • 10 = Null
  • 11 = Undefined
  • 12 = Date
  • 13 = Raw
  • 14 = Bytes
  • 15 = Guid
  • 16 = Uri
  • 17 = TimeSpan
  • 100 = Html
value
 value string

V2.EventParameterOptions

  • 0 = None
  • 1 = ExcludeFromCategorization

  • 0 = None
  • 1 = ExcludeFromCategorization
integer

V2.EventParameterTypes

  • 0 = None
  • 1 = Object
  • 2 = Array
  • 3 = Constructor
  • 4 = Property
  • 5 = Comment
  • 6 = Integer
  • 7 = Float
  • 8 = String
  • 9 = Boolean
  • 10 = Null
  • 11 = Undefined
  • 12 = Date
  • 13 = Raw
  • 14 = Bytes
  • 15 = Guid
  • 16 = Uri
  • 17 = TimeSpan
  • 100 = Html

  • 0 = None
  • 1 = Object
  • 2 = Array
  • 3 = Constructor
  • 4 = Property
  • 5 = Comment
  • 6 = Integer
  • 7 = Float
  • 8 = String
  • 9 = Boolean
  • 10 = Null
  • 11 = Undefined
  • 12 = Date
  • 13 = Raw
  • 14 = Bytes
  • 15 = Guid
  • 16 = Uri
  • 17 = TimeSpan
  • 100 = Html
integer

V2.EventSeverities

  • 0 = Low
  • 1 = Major
  • 2 = Critical

  • 0 = Low
  • 1 = Major
  • 2 = Critical
integer

V2.EventSourceEndpointError

Name Path Type Description
errorCode
 errorCode integer
errorDescription
 errorDescription string
teamId
 teamId string

V2.EventSourceTypes

  • 0 = None
  • 1 = Email
  • 2 = WebHook
  • 3 = Script
  • 4 = System
  • 5 = Manual
  • 6 = Voice
  • 7 = Api

  • 0 = None
  • 1 = Email
  • 2 = WebHook
  • 3 = Script
  • 4 = System
  • 5 = Manual
  • 6 = Voice
  • 7 = Api
integer

V2.EventStatusCodes

  • 0 = None
  • 1 = Processing
  • 2 = Signled
  • 3 = Filtered
  • 4 = Resolved
  • 5 = Discarded
  • 6 = Acknowledged
  • 7 = Suppressed
  • 8 = NoRuleApplied
  • 9 = MultipleTargetStatus
  • 1000 = Error

  • 0 = None
  • 1 = Processing
  • 2 = Signled
  • 3 = Filtered
  • 4 = Resolved
  • 5 = Discarded
  • 6 = Acknowledged
  • 7 = Suppressed
  • 8 = NoRuleApplied
  • 9 = MultipleTargetStatus
  • 1000 = Error
integer

V2.EventTargetDetails

Name Path Type Description
alertId
 alertId string
categoryId
 categoryId string
creationTime
 creationTime date-time
distributionId
 distributionId string
eventId
 eventId string
eventTargetStatus
 eventTargetStatus V2.EventTargetStatusCode

  • 0 = None
  • 1 = Processing
  • 2 = Signled
  • 3 = Filtered
  • 4 = Resolved
  • 5 = Discarded
  • 6 = Acknowledged
  • 7 = Suppressed
  • 1000 = Error
id
 id string
lastModified
 lastModified date-time
teamId
 teamId string

V2.EventTargetStatusCode

  • 0 = None
  • 1 = Processing
  • 2 = Signled
  • 3 = Filtered
  • 4 = Resolved
  • 5 = Discarded
  • 6 = Acknowledged
  • 7 = Suppressed
  • 1000 = Error

  • 0 = None
  • 1 = Processing
  • 2 = Signled
  • 3 = Filtered
  • 4 = Resolved
  • 5 = Discarded
  • 6 = Acknowledged
  • 7 = Suppressed
  • 1000 = Error
integer

V2.HolidayDetails

Name Path Type Description
day
 day integer
month
 month V2.Month

  • 0 = Unset
  • 1 = January
  • 2 = February
  • 3 = March
  • 4 = April
  • 5 = May
  • 6 = June
  • 7 = July
  • 8 = August
  • 9 = September
  • 10 = October
  • 11 = November
  • 12 = December
repeating
 repeating boolean
year
 year integer

V2.InvitationResult

Name Path Type Description
errorCode
 errorCode integer
errorMessage
 errorMessage string
invitedUser
 invitedUser V2.InvitedUserInfo
success
 success boolean

V2.InvitedUserInfo

Name Path Type Description
mailAddress
 mailAddress string
roleId
 roleId string
status
 status V2.UserStatus

  • 0 = None
  • 1 = Deleted
  • 2 = Invited
  • 3 = Active
userId
 userId string

V2.KeywordMatchingType

  • 0 = Any
  • 1 = All

  • 0 = Any
  • 1 = All
integer

V2.Month

  • 0 = Unset
  • 1 = January
  • 2 = February
  • 3 = March
  • 4 = April
  • 5 = May
  • 6 = June
  • 7 = July
  • 8 = August
  • 9 = September
  • 10 = October
  • 11 = November
  • 12 = December

  • 0 = Unset
  • 1 = January
  • 2 = February
  • 3 = March
  • 4 = April
  • 5 = May
  • 6 = June
  • 7 = July
  • 8 = August
  • 9 = September
  • 10 = October
  • 11 = November
  • 12 = December
integer

V2.NotificationProfileDetails

Name Path Type Description
channel
 channel V2.ChannelType

  • 0 = None
  • 1 = Push
  • 2 = Email
  • 4 = Bot
  • 8 = Voice
  • 16 = SMS
delayInMinutes
 delayInMinutes integer
enabled
 enabled boolean
options
 options integer
persistent
 persistent boolean

V2.OverlappingTimeSlotsDetails

Name Path Type Description
refId
 refId string
timeSlots
 timeSlots array of V2.TimeSlotDetails

V2.PermissionError

Name Path Type Description
errorCode
 errorCode integer
errorDescription
 errorDescription string
teamId
 teamId string

V2.PhoneNumberValidationStatus

  • 0 = NotValidated
  • 1 = Validated
  • 2 = CountryNotSupported

  • 0 = NotValidated
  • 1 = Validated
  • 2 = CountryNotSupported
integer

V2.RemoteActionDefinitionDetails

Name Path Type Description
parameters
 parameters array of V2.RemoteActionDefinitionParameterDetails
createdAt
 createdAt date-time
description
 description string
executorService
 executorService string
externalId
 externalId string
id
 id string
name
 name string
statusCode
 statusCode V2.RemoteActionDefinitionStatus

  • 0 = Disabled
  • 1 = Enabled
  • 2 = Invalid
statusDescription
 statusDescription string
type
 type V2.RemoteActionTypes

  • 0 = Unknown
  • 1 = Script
  • 2 = EnterpriseAlert
  • 3 = Webhook
version
 version integer

V2.RemoteActionDefinitionParameterDetails

Name Path Type Description
controlType
 controlType V2.RemoteActionParameterControlTypes

  • 0 = Text
  • 1 = MultiLineText
  • 2 = Integer
  • 3 = Double
  • 4 = Bool
  • 5 = Time
  • 6 = Date
  • 7 = TimeZone
  • 8 = Password
  • 9 = PIN
  • 10 = SingleChoice
  • 11 = MultiChoice
  • 12 = Suggestion
defaultValue
 defaultValue string
description
 description string
displayName
 displayName string
name
 name string
options
 options V2.RemoteActionParameterOptions

  • 0 = None
  • 1 = Required
  • 2 = Locked
  • 4 = Encrypted
order
 order integer
values
 values array of string

V2.RemoteActionDefinitionStatus

  • 0 = Disabled
  • 1 = Enabled
  • 2 = Invalid

  • 0 = Disabled
  • 1 = Enabled
  • 2 = Invalid
integer

V2.RemoteActionDetails

Name Path Type Description
parameters
 parameters array of V2.RemoteActionParameter
access
 access array of V2.RemoteActionTeamAccessDetails
createdAt
 createdAt date-time
currentPrincipal
 currentPrincipal V2.RemoteActionPrincipalAccessDetails
definitionId
 definitionId string
definitionVersion
 definitionVersion integer
description
 description string
enabled
 enabled boolean
executorService
 executorService string
externalId
 externalId string
id
 id string
name
 name string
statusCode
 statusCode V2.RemoteActionStatus

  • 0 = Disabled
  • 1 = Enabled
  • 2 = Invalid
  • 4 = ProviderDisabled
statusDescription
 statusDescription string
subscriptionId
 subscriptionId string
teamId
 teamId string
type
 type V2.RemoteActionTypes

  • 0 = Unknown
  • 1 = Script
  • 2 = EnterpriseAlert
  • 3 = Webhook

V2.RemoteActionInfo

Name Path Type Description
access
 access array of V2.RemoteActionTeamAccessDetails
createdAt
 createdAt date-time
currentPrincipal
 currentPrincipal V2.RemoteActionPrincipalAccessDetails
definitionId
 definitionId string
description
 description string
enabled
 enabled boolean
id
 id string
name
 name string
statusCode
 statusCode V2.RemoteActionStatus

  • 0 = Disabled
  • 1 = Enabled
  • 2 = Invalid
  • 4 = ProviderDisabled
statusDescription
 statusDescription string
subscriptionId
 subscriptionId string
teamId
 teamId string
type
 type V2.RemoteActionTypes

  • 0 = Unknown
  • 1 = Script
  • 2 = EnterpriseAlert
  • 3 = Webhook

V2.RemoteActionParameter

Name Path Type Description
controlType
 controlType V2.RemoteActionParameterControlTypes

  • 0 = Text
  • 1 = MultiLineText
  • 2 = Integer
  • 3 = Double
  • 4 = Bool
  • 5 = Time
  • 6 = Date
  • 7 = TimeZone
  • 8 = Password
  • 9 = PIN
  • 10 = SingleChoice
  • 11 = MultiChoice
  • 12 = Suggestion
displayName
 displayName string
name
 name string
options
 options V2.RemoteActionParameterOptions

  • 0 = None
  • 1 = Required
  • 2 = Locked
  • 4 = Encrypted
order
 order integer
value
 value string
values
 values array of string

V2.RemoteActionParameterControlTypes

  • 0 = Text
  • 1 = MultiLineText
  • 2 = Integer
  • 3 = Double
  • 4 = Bool
  • 5 = Time
  • 6 = Date
  • 7 = TimeZone
  • 8 = Password
  • 9 = PIN
  • 10 = SingleChoice
  • 11 = MultiChoice
  • 12 = Suggestion

  • 0 = Text
  • 1 = MultiLineText
  • 2 = Integer
  • 3 = Double
  • 4 = Bool
  • 5 = Time
  • 6 = Date
  • 7 = TimeZone
  • 8 = Password
  • 9 = PIN
  • 10 = SingleChoice
  • 11 = MultiChoice
  • 12 = Suggestion
integer

V2.RemoteActionParameterOptions

  • 0 = None
  • 1 = Required
  • 2 = Locked
  • 4 = Encrypted

  • 0 = None
  • 1 = Required
  • 2 = Locked
  • 4 = Encrypted
integer

V2.RemoteActionPrincipalAccessDetails

Name Path Type Description
canEdit
 canEdit boolean
canExecute
 canExecute boolean

V2.RemoteActionStatus

  • 0 = Disabled
  • 1 = Enabled
  • 2 = Invalid
  • 4 = ProviderDisabled

  • 0 = Disabled
  • 1 = Enabled
  • 2 = Invalid
  • 4 = ProviderDisabled
integer

V2.RemoteActionTeamAccessDetails

Name Path Type Description
canEdit
 canEdit boolean
canExecute
 canExecute boolean
teamId
 teamId string

V2.RemoteActionTypes

  • 0 = Unknown
  • 1 = Script
  • 2 = EnterpriseAlert
  • 3 = Webhook

  • 0 = Unknown
  • 1 = Script
  • 2 = EnterpriseAlert
  • 3 = Webhook
integer

V2.RemoteJob

Name Path Type Description
parameters
 parameters array of V2.RemoteJobParameter
actionId
 actionId string
activatedAt
 activatedAt date-time
createdAt
 createdAt date-time
creatorInfo
 creatorInfo V2.RemoteJobCreatorDetails
definitionId
 definitionId string
externalId
 externalId string
id
 id string
lastUpdate
 lastUpdate date-time
options
 options V2.RemoteJobOptions

  • 0 = None
startedAt
 startedAt date-time
statusCode
 statusCode V2.RemoteJobStatusCodes

  • 0 = None
  • 1 = Pending
  • 2 = Ready
  • 4 = Running
  • 8 = Executed
  • 16 = Error
statusDescription
 statusDescription string
statusDetails
 statusDetails string
type
 type V2.RemoteActionTypes

  • 0 = Unknown
  • 1 = Script
  • 2 = EnterpriseAlert
  • 3 = Webhook

V2.RemoteJobCreatorDetails

Name Path Type Description
referenceId
 referenceId string
referenceName
 referenceName string
type
 type V2.RemoteJobCreatorType

  • 0 = None
  • 1 = User
  • 2 = ApiKey
  • 3 = System

V2.RemoteJobCreatorType

  • 0 = None
  • 1 = User
  • 2 = ApiKey
  • 3 = System

  • 0 = None
  • 1 = User
  • 2 = ApiKey
  • 3 = System
integer

V2.RemoteJobOptions

  • 0 = None

  • 0 = None
integer

V2.RemoteJobParameter

Name Path Type Description
name
 name string
value
 value string

V2.RemoteJobStatusCodes

  • 0 = None
  • 1 = Pending
  • 2 = Ready
  • 4 = Running
  • 8 = Executed
  • 16 = Error

  • 0 = None
  • 1 = Pending
  • 2 = Ready
  • 4 = Running
  • 8 = Executed
  • 16 = Error
integer

V2.ScheduleDetails

Name Path Type Description
end
 end date-time
id
 id string
options
 options integer
start
 start date-time
teamId
 teamId string
userId
 userId string

V2.TeamDutySettingsDetails

Name Path Type Description
autosnapEnabled
 autosnapEnabled boolean
dutyAssistantEnabled
 dutyAssistantEnabled boolean
dutyChangeNotificationsEnabled
 dutyChangeNotificationsEnabled boolean
dutyLength
 dutyLength integer
handoverDate
 handoverDate date-time
handoverTime
 handoverTime integer
handoverWeekDay
 handoverWeekDay integer
minMemberOnDuty
 minMemberOnDuty integer
schedulingEnabled
 schedulingEnabled boolean
shiftReportCarbonCopyMail
 shiftReportCarbonCopyMail string
shiftReportEnabled
 shiftReportEnabled boolean
teamId
 teamId string
timezone
 timezone string

V2.TeamDutySettingsError

Name Path Type Description
errorCode
 errorCode integer
errorDescription
 errorDescription string
teamId
 teamId string

V2.TeamDutySummaryError

Name Path Type Description
errorCode
 errorCode integer
errorDescription
 errorDescription string
userId
 userId string

V2.TeamHolidayDetails

Name Path Type Description
holidays
 holidays array of V2.HolidayDetails
teamId
 teamId string

V2.TeamImageDetails

Name Path Type Description
content
 content byte
contentDispostion
 contentDispostion string
contentEncoding
 contentEncoding string
contentType
 contentType string
lastModified
 lastModified date-time
name
 name string

V2.TeamMembershipDetails

Name Path Type Description
mailAddress
 mailAddress string
memberSince
 memberSince date-time
roleId
 roleId string
status
 status V2.UserStatus

  • 0 = None
  • 1 = Deleted
  • 2 = Invited
  • 3 = Active
teamId
 teamId string
userId
 userId string

V2.TeamPermissions

Name Path Type Description
permissions
 permissions array of UserPermission
teamId
 teamId string

V2.TeamPrivacySettingsDetails

Name Path Type Description
hideContactAddresses
 hideContactAddresses boolean
hideDutyData
 hideDutyData boolean
hideForEscalation
 hideForEscalation boolean
teamId
 teamId string

V2.TeamPublicDetails

Name Path Type Description
id
 id string
name
 name string
privacySettings
 privacySettings V2.TeamPrivacySettingsDetails

V2.TeamUserError

Name Path Type Description
errorCode
 errorCode integer
errorDescription
 errorDescription string
teamId
 teamId string

V2.TimeSlotDetails

Name Path Type Description
end
 end V2.WeekTimeDetails
id
 id string
start
 start V2.WeekTimeDetails

V2.TimeSlotValidationResultDetails

Name Path Type Description
isOverlapping
 isOverlapping boolean
item
 item V2.TimeSlotDetails
overlappingTimeSlots
 overlappingTimeSlots array of V2.OverlappingTimeSlotsDetails
valid
 valid boolean

V2.UserDeliveryStatus

Name Path Type Description
statusCode
 statusCode V2.UserDeliveryStatusCodes

  • 0 = None
  • 1 = Open
  • 2 = Failed
  • 4 = Transmitted
  • 6 = Delivered
  • 8 = Protected
  • 9 = AbuseProtected
  • 24 = PartlyTransmitted
  • 26 = PartlyDelivered
  • 30 = NotOnDuty
  • 31 = CategoryOptOut
  • 32 = NoMessagesSent
userId
 userId string

V2.UserDeliveryStatusCodes

  • 0 = None
  • 1 = Open
  • 2 = Failed
  • 4 = Transmitted
  • 6 = Delivered
  • 8 = Protected
  • 9 = AbuseProtected
  • 24 = PartlyTransmitted
  • 26 = PartlyDelivered
  • 30 = NotOnDuty
  • 31 = CategoryOptOut
  • 32 = NoMessagesSent

  • 0 = None
  • 1 = Open
  • 2 = Failed
  • 4 = Transmitted
  • 6 = Delivered
  • 8 = Protected
  • 9 = AbuseProtected
  • 24 = PartlyTransmitted
  • 26 = PartlyDelivered
  • 30 = NotOnDuty
  • 31 = CategoryOptOut
  • 32 = NoMessagesSent
integer

V2.UserDetails

Name Path Type Description
colorIndex
 colorIndex integer
contactAddresses
 contactAddresses array of
dutyInfos
 dutyInfos array of V2.UserDutyDetails
externalAuthProvider
 externalAuthProvider string
id
 id string
isDeactivated
 isDeactivated boolean
isInvite
 isInvite boolean
lastSeen
 lastSeen date-time
mail
 mail string
name
 name string
remoteActionPinSet
 remoteActionPinSet boolean
subscriptionId
 subscriptionId string
timeZone
 timeZone string
userImageLastModified
 userImageLastModified date-time

V2.UserDutyDetails

Name Path Type Description
dutyMode
 dutyMode V2.DutyModes

  • 0 = None
  • 1 = Primary
  • 100 = Manager
lastChange
 lastChange date-time
onDutyTime
 onDutyTime integer
overdue
 overdue boolean
teamId
 teamId string
userId
 userId string

V2.UserLocaleResponseDetails

Name Path Type Description
id
 id string
language
 language string
timeZone
 timeZone string

V2.UserPhoneNumberDetails

Name Path Type Description
countryCode
 countryCode string
phoneNumber
 phoneNumber string
validationStatus
 validationStatus V2.PhoneNumberValidationStatus

  • 0 = NotValidated
  • 1 = Validated
  • 2 = CountryNotSupported

V2.UserStatus

  • 0 = None
  • 1 = Deleted
  • 2 = Invited
  • 3 = Active

  • 0 = None
  • 1 = Deleted
  • 2 = Invited
  • 3 = Active
integer

V2.WeekTimeDetails

Name Path Type Description
hour
 hour integer
minutes
 minutes integer
weekday
 weekday V2.Weekday

  • 0 = Holiday
  • 1 = Monday
  • 2 = Tuesday
  • 3 = Wednesday
  • 4 = Thursday
  • 5 = Friday
  • 6 = Saturday
  • 7 = Sunday

V2.Weekday

  • 0 = Holiday
  • 1 = Monday
  • 2 = Tuesday
  • 3 = Wednesday
  • 4 = Thursday
  • 5 = Friday
  • 6 = Saturday
  • 7 = Sunday

  • 0 = Holiday
  • 1 = Monday
  • 2 = Tuesday
  • 3 = Wednesday
  • 4 = Thursday
  • 5 = Friday
  • 6 = Saturday
  • 7 = Sunday
integer

WebhookInfo

Name Path Type Description
description
 description string
enabled
 enabled boolean
extUrl
 extUrl string
id
 id string
name
 name string
subId
 subId string
teamId
 teamId string

string

This is the basic data type 'string'.

binary

This is the basic data type 'binary'.