@datafire/signl4 v3.0.0

@datafire/signl4

Client library for SIGNL4

Installation and Usage

npm install --save @datafire/signl4

let signl4 = require('@datafire/signl4').create();

.then(data => {
  console.log(data);
});

Description

With our API, you can easily access many SIGNL4 functions via HTTP requests. It is based on REST and fulfills a similar purpose for which SDKs were used very often in the past. Example usage scenarios are the integration in third party systems for triggering alarms to your team or on-call duty based on shift planning systems. The API is always used in the context of your SIGNL4 team, i. e. you must log in with your SIGNL4 account and give your API client the authorization to access your team programmatically on your behalf (constent grant). At the moment there are several certified API clients, e.g. Microsoft Flow or Amazon Alexa. Registration of your personal API client is currently possible on request. Don't hesitate to contact us and you'll get your client_id and client_secret required for accessing the SIGNL4 API after user login and consent grant. Authentication is based on OpenID Connect and the Authorization Code Flow. The base URL of the API is https://connect.signl4.com/api/. Copyright © Derdack GmbH

Actions

AcceptSubscriptionAdoption

Accept an existing subscription adoption.

signl4.AcceptSubscriptionAdoption({
  "acceptCode": ""
}, context)

Input

• input object
  • acceptCode required string

Output

• output SubscriptionInfo

RaiseAlert

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

signl4.RaiseAlert({}, context)

Input

• input object
  • alertInfo RaiseAlertInfo

Output

• output AlertInfo

AcknowledgeAll

This method confirms all unhandled alerts your team currently has.

signl4.AcknowledgeAll({}, context)

Input

• input object
  • filterInfo ChangeAlertStatusFilterInfo

Output

Output schema unknown

AcknowledgeMultiple

This method confirms all alerts provided.

signl4.AcknowledgeMultiple({}, context)

Input

• input object
  • acknowledgeInfo ChangeAlertStatusMultipleInfo

Output

Output schema unknown

CloseAll

This method closes all acknowledged alerts your team currently has.

signl4.CloseAll({}, context)

Input

• input object
  • filterInfo ChangeAlertStatusFilterInfo

Output

Output schema unknown

CloseMultiple

This method closes all alerts provided.

signl4.CloseMultiple({}, context)

Input

• input object
  • statusChangeInfo ChangeAlertStatusMultipleInfo

Output

Output schema unknown

GetAlertsPaged

Gets alerts paged

signl4.GetAlertsPaged({}, context)

Input

• input object
  • maxResults integer: Defines the limit of retrieved alert details per request. 1 to 100 are allowed per request.
  • filter AlertFilterPublic

Output

• output PagedResultsPublic[OverviewAlert]

GetAlertReport

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 your team members.

signl4.GetAlertReport(null, context)

Input

This action has no parameters

Output

• output AlertReport

GetAlert

Gets an alert by id.

signl4.GetAlert({
  "alertId": ""
}, context)

Input

• input object
  • alertId required string: Id of the requested Alert.

Output

• output AlertInfo

AnnotateAlert

Annotates an alert by given Annotation Info.

signl4.AnnotateAlert({
  "alertId": ""
}, context)

Input

• input object
  • alertId required string: Id of the alert to annotate.
  • annotationInfo AlertAnnotationInfo

Output

• output AlertAnnotationInfo

GetAlertAnnotations

Get annotations of an alert by id.

signl4.GetAlertAnnotations({
  "alertId": ""
}, context)

Input

• input object
  • alertId required string: Id of the requested Alert.

Output

• output array
  • items AlertAnnotationInfo

GetAlertAttachmentsInfo

Get attachments of an alert by id.

signl4.GetAlertAttachmentsInfo({
  "alertId": ""
}, context)

Input

• input object
  • alertId required string: Id of the requested Alert.

Output

• output array
  • items AlertAttachmentInfo

GetAttachment

Gets a specified attachment of a specified alert.

signl4.GetAttachment({
  "alertId": "",
  "attachmentId": ""
}, context)

Input

• input object
  • alertId required string: Id of the alert that contains the wanted attachment.
  • attachmentId required string: Id of the attachment, that you want to retrieve.
  • width integer: Optional parameter defining the wanted width of the picture that is retrieved.
  • height integer: Optional parameter defining the wanted height of the picture that is retrieved.
  • scale boolean: Optional parameter defining whether it's wanted to scale the retrieved image. Default is set to

Output

• output FileContentResult

GetAlertNotifications

Get notifications of all users by alert id.

signl4.GetAlertNotifications({
  "alertId": ""
}, context)

Input

• input object
  • alertId required string: Id of the requested Alert.

Output

• output array
  • items AlertNotificationInfo

GetOverviewAlert

Get overview alert by id.

signl4.GetOverviewAlert({
  "alertId": ""
}, context)

Input

• input object
  • alertId required string: Id of the requested Alert.

Output

• output OverviewAlert

GetAvailableCountries

Gets supported countries.

signl4.GetAvailableCountries(null, context)

Input

This action has no parameters

Output

• output array
  • items string

GetPreferredCurrency

Gets supported countries.

signl4.GetPreferredCurrency({}, context)

Input

• input object
  • countryCode string

Output

• output string

CreateBranch

Creates a branch with the user's subscription.

signl4.CreateBranch(null, context)

Input

This action has no parameters

Output

• output BranchInfo

AcceptManagerInvite

Accepts a pending manager invite

signl4.AcceptManagerInvite({
  "inviteAcceptCode": ""
}, context)

Input

• input object
  • inviteAcceptCode required string

Output

• output BranchManagerInformation

GetBranch

Returns information of the branch with the specified Id.

signl4.GetBranch({
  "branchId": ""
}, context)

Input

• input object
  • branchId required string: Id of the branch thats needed to be retrieved.

Output

• output BranchInfo

DeleteSubscriptionAdoption

Deletes an existing subscription adoption in the user's branch.

signl4.DeleteSubscriptionAdoption({
  "branchId": ""
}, context)

Input

• input object
  • branchId required string
  • adoptionInfo SubscriptionAdoptionInfo

Output

Output schema unknown

AdoptSubscriptionForBranch

Adopts an existing subscription in the user's branch.

signl4.AdoptSubscriptionForBranch({
  "branchId": ""
}, context)

Input

• input object
  • branchId required string
  • adoptionInfo SubscriptionAdoptionInfo

Output

• output SubscriptionInfo

GetBranchFeatures

Returns the features of a specified branch.

signl4.GetBranchFeatures({
  "branchId": ""
}, context)

Input

• input object
  • branchId required string: Id of the branch from which the features need to be retrieved.

Output

• output array
  • items SubscriptionFeature

GetBranchManagers

Gets the managers of a branch

signl4.GetBranchManagers({
  "branchId": ""
}, context)

Input

• input object
  • branchId required string: ID of the branch to get the managers for

Output

• output array
  • items BranchManagerInformation

InviteBranchManager

Gets the managers of a branch

signl4.InviteBranchManager({
  "branchId": ""
}, context)

Input

• input object
  • branchId required string
  • inviteInfos BranchManagerInviteInfos

Output

• output BranchManagerInformation

DeleteBranchManager

Deletes a specific manager of the branch

signl4.DeleteBranchManager({
  "branchId": "",
  "managerId": ""
}, context)

Input

• input object
  • branchId required string
  • managerId required string

Output

Output schema unknown

GetBranchSubscriptions

Returns subscription information of the branch with the specified Id.

signl4.GetBranchSubscriptions({
  "branchId": ""
}, context)

Input

• input object
  • branchId required string: ID of the branch the subscriptions will be retrieved for.

Output

• output array
  • items SubscriptionInfo

CreateBranchSubscription

Creates a new subscription in the user's branch.

signl4.CreateBranchSubscription({
  "branchId": ""
}, context)

Input

• input object
  • branchId required string
  • creationInfo SubscriptionCreationInfo

Output

• output SubscriptionInfo

RemoveSubscriptionFromBranch

Removes a subscription from the user's branch.

signl4.RemoveSubscriptionFromBranch({
  "branchId": "",
  "subscriptionId": ""
}, context)

Input

• input object
  • branchId required string
  • subscriptionId required string

Output

Output schema unknown

GetBranchUserLicenses

Gets user license information of a branch

signl4.GetBranchUserLicenses({
  "branchId": ""
}, context)

Input

• input object
  • branchId required string: ID of the branch to get user license information for

Output

• output array
  • items UserLicenseInfo

UpdateBranchUserLicenses

Updates user license information of a branch

signl4.UpdateBranchUserLicenses({
  "branchId": ""
}, context)

Input

• input object
  • branchId required string: ID of the branch to update user license information for
  • licenseUpdate UserLicenseUpdate

Output

• output UserLicenseInfo

ValidateAdoptionRequirements

Check if there are enough user licenses to adopt an existing subscription in the user's branch.

signl4.ValidateAdoptionRequirements({
  "branchId": ""
}, context)

Input

• input object
  • branchId required string
  • adoptionInfo SubscriptionAdoptionInfo

Output

• output AdoptionValidationResult

SetPersonalCategorySettings

signl4.SetPersonalCategorySettings({}, context)

Input

• input object
  • categoryUpdates CategoryUpdates

Output

• output array
  • items PersonalCategorySettings

GetCategories

Returns information about all categories that belong to the team.

signl4.GetCategories({
  "teamId": ""
}, context)

Input

• input object
  • teamId required string: Id of the team the categories belong to

Output

• output array
  • items CategoryInfo

GetEventsPaged

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

signl4.GetEventsPaged({}, context)

Input

• input object
  • maxResults integer: Defines the limit of retrieved alert details per request. 1 to 100 are allowed per request.
  • eventFilter EventFilter

Output

• output PagedResultsPublic[OverviewEvent]

GetOverviewEvent

Get overview event by id.

signl4.GetOverviewEvent({
  "eventId": ""
}, context)

Input

• input object
  • eventId required string: Id of event to get.

Output

• output OverviewEvent

GetEventParameters

Get parameters of an event by id.

signl4.GetEventParameters({
  "eventId": ""
}, context)

Input

• input object
  • eventId required string: Event Id of the requested Alert.

Output

• output array
  • items EventParameterInfo

ConfirmDeliveries

Confirm delivery of messages by message id, channel id and subscription Id.

signl4.ConfirmDeliveries({}, context)

Input

• input object
  • confirmation MessageDeliveryConfirmation

Output

Output schema unknown

GetPlans

Returns information about all available plans.

signl4.GetPlans({}, context)

Input

• input object
  • language string: Language of the plan infos. For example "en" or "de"

Output

• output PlanInfo

GetPlan

Returns information of the plan with the specified Id.

signl4.GetPlan({
  "planId": ""
}, context)

Input

• input object
  • planId required string: Id of the plan thats needed to be retrieved.
  • language string: Language of the plan infos. For example "en" or "de"

Output

• output PlanInfo

GetPlanChannelPrices

Returns the plan's channel price information.

signl4.GetPlanChannelPrices({
  "planId": ""
}, context)

Input

• input object
  • planId required string: Id of the plan thats needed to be retrieved.

Output

• output ChannelPriceInfo

GetPlanUserPrices

Returns the plan's user price information.

signl4.GetPlanUserPrices({
  "planId": ""
}, context)

Input

• input object
  • planId required string: Id of the plan thats needed to be retrieved.
  • annual boolean: Gets annual user prices if set to TRUE, otherwise the prices are monthly.

Output

• output array
  • items PriceInfo

GetPrepaidPackages

Returns information about all avialable prepaid packages.

signl4.GetPrepaidPackages({}, context)

Input

• input object
  • language string: Language of the package infos. For example "en" or "de"

Output

• output PrepaidPackageInfo

GetPrepaidBalance

Get your subscription's current prepaid balance.

signl4.GetPrepaidBalance(null, context)

Input

This action has no parameters

Output

• output PrepaidBalanceInfo

GetPrepaidSettings

Get your subscription's current prepaid settings.

signl4.GetPrepaidSettings(null, context)

Input

This action has no parameters

Output

• output PrepaidSettingsInfo

UpdatePrepaidSettings

Update your subscription's current prepaid settings.

signl4.UpdatePrepaidSettings({}, context)

Input

• input object
  • settings PrepaidSettingsInfo

Output

• output PrepaidSettingsInfo

GetPrepaidTransactions

Get your subscription's prepaid transactions.

signl4.GetPrepaidTransactions(null, context)

Input

This action has no parameters

Output

• output PrepaidSettingsInfo

CreatePrepaidTransaction

Creates a prepaid transaction for your subscription.

signl4.CreatePrepaidTransaction({}, context)

Input

• input object
  • creationInfo PrepaidTransactionCreationInfo

Output

• output PrepaidTransactionInfo

GetPrepaidTransaction

Get your subscription's prepaid transaction.

signl4.GetPrepaidTransaction({
  "transactionId": ""
}, context)

Input

• input object
  • transactionId required string: ID of the transaction to get

Output

• output PrepaidSettingsInfo

GetScriptInstances

Returns all script instances in the subscription.

signl4.GetScriptInstances(null, context)

Input

This action has no parameters

Output

• output array
  • items ScriptInstanceDetails

CreateScriptInstance

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

signl4.CreateScriptInstance({}, context)

Input

• input object
  • instanceInfo ScriptInstanceDetails

Output

• output ScriptInstanceDetails

DeleteScriptInstance

Gets the script instance specified by the passed instance id.

signl4.DeleteScriptInstance({
  "instanceId": ""
}, context)

Input

• input object
  • instanceId required string: Instance Id of script instance to be returned.

Output

Output schema unknown

GetScriptInstance

Gets the script instance specified by the passed instance id.

signl4.GetScriptInstance({
  "instanceId": ""
}, context)

Input

• input object
  • instanceId required string: Instance Id of script instance to be returned.

Output

• output ScriptInstanceDetails

UpdateScriptInstance

Updates the specified script instance.

signl4.UpdateScriptInstance({
  "instanceId": ""
}, context)

Input

• input object
  • instanceInfo ScriptInstanceDetails
  • instanceId required string: InstanceId of the script to be updated.

Output

• output ScriptInstanceDetails

UpdateScriptInstanceCustomData

Updates the specified script instance.

signl4.UpdateScriptInstanceCustomData({
  "instanceId": ""
}, context)

Input

• input object
  • instanceData ScriptInstanceCustomUserData
  • instanceId required string: InstanceId of the script to be updated.

Output

• output ScriptInstanceDetails

DisableInstance

signl4.DisableInstance({
  "instanceId": ""
}, context)

Input

• input object
  • instanceId required string

Output

• output ScriptInstanceDetails

EnableInstance

signl4.EnableInstance({
  "instanceId": ""
}, context)

Input

• input object
  • instanceId required string

Output

• output ScriptInstanceDetails

GetInventoryScripts

Returns all script instances in the subscription.

signl4.GetInventoryScripts(null, context)

Input

This action has no parameters

Output

• output array
  • items InventoryScriptInfo

GetParsedInventoryScripts

signl4.GetParsedInventoryScripts({}, context)

Input

• input object
  • language string

Output

• output array
  • items InventoryScriptInfo

GetParsedInventoryScript

Gets the script specified by the passed script id.

signl4.GetParsedInventoryScript({
  "scriptId": ""
}, context)

Input

• input object
  • scriptId required string: script Id of script to be returned.
  • language string

Output

• output ScriptInstanceDetails

GetSubscriptions

Get infos of all available/managed subscriptions.

signl4.GetSubscriptions(null, context)

Input

This action has no parameters

Output

• output array
  • items SubscriptionInfo

DeleteSubscription

Delete a specific subscription.

signl4.DeleteSubscription({
  "subscriptionId": ""
}, context)

Input

• input object
  • subscriptionId required string: ID of the subscription to be deleted.

Output

Output schema unknown

GetSubscription

Get infos of a specific subscription.

signl4.GetSubscription({
  "subscriptionId": ""
}, context)

Input

• input object
  • subscriptionId required string: Id of the subscription thats to be retrieved.

Output

• output SubscriptionInfo

GetChannelPrices

Returns the subscription's channel price information.

signl4.GetChannelPrices({
  "subscriptionId": ""
}, context)

Input

• input object
  • subscriptionId required string: Id of the subscription that needs to be retrieved.

Output

• output ChannelPriceInfo

GetSubscriptionFeatures

Returns the features of a specified subscription.

signl4.GetSubscriptionFeatures({
  "subscriptionId": ""
}, context)

Input

• input object
  • subscriptionId required string: Id of the subscription from which the features need to be retrieved.

Output

• output array
  • items SubscriptionFeature

GetPrepaidBalanceForSubscription

Get a subscription's current prepaid balance.

signl4.GetPrepaidBalanceForSubscription({
  "subscriptionId": ""
}, context)

Input

• input object
  • subscriptionId required string

Output

• output PrepaidBalanceInfo

GetPrepaidSettingsForSubscription

Get a subscription's current prepaid settings.

signl4.GetPrepaidSettingsForSubscription({
  "subscriptionId": ""
}, context)

Input

• input object
  • subscriptionId required string

Output

• output PrepaidSettingsInfo

UpdatePrepaidSettingsForSubscription

Update a subscription's current prepaid settings.

signl4.UpdatePrepaidSettingsForSubscription({
  "subscriptionId": ""
}, context)

Input

• input object
  • subscriptionId required string: ID of the subscription
  • settings PrepaidSettingsInfo

Output

• output PrepaidSettingsInfo

subscriptions.subscriptionId.prepaidTransactions.get

Get a subscription's prepaid transactions.

signl4.subscriptions.subscriptionId.prepaidTransactions.get({
  "subscriptionId": ""
}, context)

Input

• input object
  • subscriptionId required string: ID of the subscription to get transactions for

Output

• output PrepaidSettingsInfo

subscriptions.subscriptionId.prepaidTransactions.post

Creates a prepaid transaction for a subscription.

signl4.subscriptions.subscriptionId.prepaidTransactions.post({
  "subscriptionId": ""
}, context)

Input

• input object
  • subscriptionId required string: ID of the subscription to create transaction for
  • creationInfo PrepaidTransactionCreationInfo

Output

• output PrepaidTransactionInfo

GetPrepaidTransactionForSubscription

Get a subscription's prepaid transaction.

signl4.GetPrepaidTransactionForSubscription({
  "subscriptionId": "",
  "transactionId": ""
}, context)

Input

• input object
  • subscriptionId required string: ID of the subscription to get transactions for
  • transactionId required string: ID of the transaction to get

Output

• output PrepaidSettingsInfo

UpdateSubscriptionProfile

Updates a subscriptions profile.

signl4.UpdateSubscriptionProfile({
  "subscriptionId": ""
}, context)

Input

• input object
  • subscriptionId required string: ID of the subscription to be updated
  • profile SubscriptionProfile

Output

• output SubscriptionInfo

GetSubscriptionTeams

Get infos for all teams of the subscription.

signl4.GetSubscriptionTeams({
  "subscriptionId": ""
}, context)

Input

• input object
  • subscriptionId required string

Output

• output array
  • items TeamInfo

GetSubscriptionUserLicenses

Gets a subscription's user licences.

signl4.GetSubscriptionUserLicenses({
  "subscriptionId": ""
}, context)

Input

• input object
  • subscriptionId required string: ID of the subscription

Output

• output UserLicenseInfo

UpdateSubscriptionUserLicenses

Updates a subscription's user licences.

signl4.UpdateSubscriptionUserLicenses({
  "subscriptionId": ""
}, context)

Input

• input object
  • subscriptionId required string: ID of the subscription to be updated
  • licenseUpdate UserLicenseUpdate

Output

• output UserLicenseInfo

GetTeams

Get infos of all teams.

signl4.GetTeams(null, context)

Input

This action has no parameters

Output

• output array
  • items TeamInfo

GetTeam

Gets infos of a specific team.

signl4.GetTeam({
  "teamId": ""
}, context)

Input

• input object
  • teamId required string: ID of the team that should be retrieved.

Output

• output TeamInfo

GetAlertSettings

Gets alert settings of a specific team.

signl4.GetAlertSettings({
  "teamId": ""
}, context)

Input

• input object
  • teamId required string: ID of the team the settings should be retrieved for.

Output

• output AlertSettings

SetAlertSettings

Sets alert settings of a specific team.

signl4.SetAlertSettings({
  "teamId": ""
}, context)

Input

• input object
  • teamId required string: ID of the team the settings should be set for.
  • settings AlertSettings

Output

• output AlertSettings

GetTeamDutySummary

Get duty assistent info for a team

signl4.GetTeamDutySummary({
  "teamId": ""
}, context)

Input

• input object
  • teamId required string: ID of the team the duty belongs to.
  • lastTwoDuties boolean

Output

• output TeamDutySummaryInfo

GetDutySchedules

Returns information about all duties that belong to the team.

signl4.GetDutySchedules({
  "teamId": ""
}, context)

Input

• input object
  • teamId required string: Id of the team the schedules user belongs to
  • UserId string
  • MinDate string
  • Limit integer

Output

• output array
  • items ScheduleInfo

SetDutySchedule

Create/Update given duty schedule.

signl4.SetDutySchedule({
  "teamId": ""
}, context)

Input

• input object
  • teamId required string: Id of the team the duty is to be assigned to.
  • schedule ScheduleInfo

Output

• output ScheduleInfo

DeleteDutySchedule

Delete a specific duty.

signl4.DeleteDutySchedule({
  "teamId": "",
  "dutyId": ""
}, context)

Input

• input object
  • teamId required string: ID of the team the duty belongs to.
  • dutyId required string: ID of the duty to be deleted.

Output

Output schema unknown

GetDutySchedule

Returns information of the duty schedule with the specified Id.

signl4.GetDutySchedule({
  "teamId": "",
  "scheduleId": ""
}, context)

Input

• input object
  • teamId required string: Id of the team the duty belongs to
  • scheduleId required string: Id of the duty schedule thats needed to be retrieved.

Output

• output ScheduleInfo

teams.teamId.setupProgress.get

Gets setup progress of a specific team.

signl4.teams.teamId.setupProgress.get({
  "teamId": ""
}, context)

Input

• input object
  • teamId required string: ID of the team the progress should be retrieved for.

Output

• output TeamSetupProgress

GetUsers

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

signl4.GetUsers(null, context)

Input

This action has no parameters

Output

• output array
  • items UserInfo

GetUser

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

signl4.GetUser({
  "userId": ""
}, context)

Input

• input object
  • userId required string: Identifier of the user to get. Use 'Me' to get information about the currently logged in user. Can

Output

• output UserInfo

GetBranchInfosByUser

Returns information of the branch that is managed by user with the specified Id.

signl4.GetBranchInfosByUser({
  "userId": ""
}, context)

Input

• input object
  • userId required string: Id of branch manager.

Output

• output UserBranchInfo

CheckPermissions

Checks if a user has the provided permission.

signl4.CheckPermissions({
  "userId": ""
}, context)

Input

• input object
  • userId required string: ID of the user to check permissions for.
  • teamId string
  • permissions ItemsWrapper[String]

Output

• output UserImage

GetUserDutyInfo

Returns a object with duty information.

signl4.GetUserDutyInfo({
  "userId": ""
}, context)

Input

• input object
  • userId required string: Identifier of the user to get. Use 'Me' to get information about the currently logged in user. Can

Output

• output UserInfo

GetUserImage

signl4.GetUserImage({
  "userId": ""
}, context)

Input

• input object
  • userId required string
  • height integer
  • width integer

Output

• output UserImage

PunchInUser

The specified user will be punched in to duty.

signl4.PunchInUser({
  "userId": ""
}, context)

Input

• input object
  • userId required string: Identifier of the user to punch in. Use 'Me' to get information about the currently logged in

Output

• output UserDutyInfo

PunchInUserAsManager

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

signl4.PunchInUserAsManager({
  "userId": ""
}, context)

Input

• input object
  • userId required string: Identifier of the user to punch in. Use 'Me' to get information about the currently logged in

Output

• output UserDutyInfo

PunchOutUser

The specified user will be punched out from duty.

signl4.PunchOutUser({
  "userId": ""
}, context)

Input

• input object
  • userId required string: Identifier of the user to punch out. Use 'Me' to get information about the currently logged in

Output

• output UserDutyInfo

users.userId.setupProgress.get

Gets setup progress of a specific user.

signl4.users.userId.setupProgress.get({
  "userId": ""
}, context)

Input

• input object
  • userId required string: ID of the user the progress should be retrieved for.

Output

• output UserSetupProgress

Get

Returns a collection of defined outbound webhooks in the system.

signl4.Get(null, context)

Input

This action has no parameters

Output

• output array
  • items WebhookInfo

Create

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

signl4.Create({}, context)

Input

• input object
  • webhookBaseInfo WebhookBaseInfo

Output

• output string

Delete

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

signl4.Delete({
  "webhookId": ""
}, context)

Input

• input object
  • webhookId required string: Id of the outbound webhook that will be deleted.

Output

Output schema unknown

GetWebhookById

Returns information of the webhook specified by the passed id.

signl4.GetWebhookById({
  "webhookId": ""
}, context)

Input

• input object
  • webhookId required string: Id of the outbound webhook to be retrieved.

Output

• output string

Update

Updates the specified webhook.

signl4.Update({
  "webhookId": ""
}, context)

Input

• input object
  • webhookId required string: Id of the outbound webhook to be updated.
  • webhookUpdateInfo WebhookBaseInfo

Output

• output WebhookInfo

Definitions

AdoptionValidationResult

• AdoptionValidationResult object
  • availableLicenses integer
  • isValid boolean
  • planCode string
  • requiredLicenses integer

AlertAnnotationInfo

• AlertAnnotationInfo object
  • text string
  • timestamp string
  • type integer
  • userId string

AlertAttachment

• AlertAttachment object
  • content string
  • contentType string
  • encoding integer (values: 0, 1)
  • id string
  • name string

AlertAttachmentInfo

• AlertAttachmentInfo object
  • contentType string
  • id string
  • name string

AlertCounts

• AlertCounts object
  • acknowledged required integer
  • closed integer
  • end string
  • lastModified string
  • start string
  • unhandled required integer

AlertDeliveryStatusInfo

• AlertDeliveryStatusInfo object
  • alertDeliveryStatusCode integer (values: 0, 1, 2, 4, 6, 8, 22, 24, 26, 30, 31)
  • userDeliveryStatusInfos array
    • items UserDeliveryStatusInfo

AlertFilterPublic

• AlertFilterPublic object
  • afterid string
  • alertStatuscodes integer (values: 0, 1, 2, 4, 8, 16, 32)
  • alertids array
    • items string
  • categoryids array
    • items string
  • continuationtoken PagedResultsPublicContinuationToken
  • maxcreated string
  • mincreated string
  • modsince string
  • showpersonalhiddencategories boolean
  • textToSearch string

AlertHistoryInfo

• AlertHistoryInfo object
  • acknowledged string
  • acknowledgedgements array
    • items string
  • closed string
  • closedBy string
  • created string

AlertHistoryInfoDetailed

• AlertHistoryInfoDetailed object
  • acknowledged string
  • alertHistoryEntries array
    • items AlertHistoryInfoEntry
  • created string

AlertHistoryInfoEntry

• AlertHistoryInfoEntry object
  • timestamp string
  • type integer (values: 2, 3)
  • userId string

AlertInfo

• AlertInfo object
  • annotations array
    • items AlertAnnotationInfo
  • attachments array
    • items AlertAttachment
  • category string
  • categoryId string
  • eventSourceId string
  • eventSourceType integer (values: 0, 1, 2)
  • externalId string
  • flags integer
  • history AlertHistoryInfo
  • id string
  • lastModified string
  • parameters array
    • items EventParameterInfo
  • severity integer (values: 0, 1, 2)
  • status integer (values: 0, 1, 2, 4, 8, 16, 32)
  • subscriptionId string
  • teamId string
  • text string
  • title string

AlertNotificationInfo

• AlertNotificationInfo object
  • address string
  • deviceName string
  • lastUpdate string
  • messageStatus integer (values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10)
  • notificationChannelType integer (values: 0, 1, 2, 4, 8, 16)
  • userId string
  • userStatus integer (values: 0, 1, 2, 3, 4, 5, 6)

AlertReport

• AlertReport object
  • last24Hours required AlertCounts
  • subscriptionId required string
  • teamCurrentDuty AlertCounts
  • teamId required string
  • teamLastDuty AlertCounts
  • userId string
  • userLastDutyChange AlertCounts

AlertSettings

• AlertSettings object
  • filterAction integer (values: 0, 1, 2)
  • filterMode integer (values: 0, 1)
  • optOut integer (values: 0, 1, 2)
  • persNotMode integer (values: 0, 1)
  • responseMode integer (values: 2, 4)
  • responseTime integer

BranchInfo

• BranchInfo object
  • billingInterval integer (values: 0, 1, 4)
  • country string
  • created string
  • currency string
  • externalAccountId string
  • externalSubscriptionId string
  • id string
  • managerIds array
    • items string
  • options integer
  • ownerId string
  • subscriptionIds array
    • items string

BranchManagerInformation

• BranchManagerInformation object
  • displayName string
  • isPending boolean
  • mailAddress string
  • managerId string
  • subscriptionId string

BranchManagerInviteInfos

• BranchManagerInviteInfos object
  • displayName required string
  • mailAddress required string

CategoryInfo

• CategoryInfo object
  • color string
  • id string
  • imageName string
  • isDefault boolean
  • keywords array
    • items string
  • name string

CategoryUpdates

• CategoryUpdates object
  • settings array
    • items PersonalCategorySettings
  • teamId string
  • userId string

ChangeAlertStatusFilterInfo

• ChangeAlertStatusFilterInfo object
  • categoryIds array
    • items string
  • maxDate string
  • minDate string

ChangeAlertStatusMultipleInfo

• ChangeAlertStatusMultipleInfo object
  • alertIds required array
    • items string
  • descr string
  • uid required string

ChannelPriceInfo

• ChannelPriceInfo object
  • sms integer
  • voicePerMinute integer

DutySummaryInfo

• DutySummaryInfo object
  • dutyEnd string
  • dutyId string
  • dutyStart string

EntityTagHeaderValue

• EntityTagHeaderValue object
  • isWeak boolean
  • tag StringSegment

ErrorResponseContent

• ErrorResponseContent object
  • code required integer
  • details string
  • errors array
    • items ErrorResponseContentBase
  • message required string
  • requestId string

ErrorResponseContentBase

• ErrorResponseContentBase object
  • details string
  • message required string

EventFilter

• EventFilter object
  • continuationToken PagedResultsPublicContinuationToken
  • eventStatusCode integer (values: 0, 1, 2, 3, 1000)
  • maxCreationDate string
  • minCreationDate string
  • modifiedSince string
  • textToSearch string

EventParameterInfo

• EventParameterInfo object
  • name string
  • type integer (values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 100)
  • value string

FileContentResult

• FileContentResult object
  • contentType string
  • enableRangeProcessing boolean
  • entityTag EntityTagHeaderValue
  • fileContents string
  • fileDownloadName string
  • lastModified string

InventoryScriptInfo

• InventoryScriptInfo object
  • config object
  • data ScriptDescriptionData
  • eventPattern object
  • localizationDetails array
    • items ScriptLocalizationDetail
  • scriptId string
  • scriptName string
  • visibility string

ItemsWrapperString

• ItemsWrapperString object
  • items array
    • items string

MessageDelivery

• MessageDelivery object
  • channelId string
  • messageId string

MessageDeliveryConfirmation

• MessageDeliveryConfirmation object
  • deliveries array
    • items MessageDelivery
  • subscriptionId string

OverviewAlert

• OverviewAlert object
  • alertDeliveryStatus AlertDeliveryStatusInfo
  • categoryId string
  • detailedHistory AlertHistoryInfoDetailed
  • externalId string
  • flags integer
  • id string
  • lastModified string
  • requiredAcknowledgements integer
  • status integer (values: 0, 1, 2, 4, 8, 16, 32)
  • subscriptionId string
  • teamId string
  • text string
  • title string

OverviewEvent

• OverviewEvent object
  • alertId string
  • categoryId string
  • creationTime string
  • eventSourceType integer (values: 0, 1, 2, 3, 4, 5)
  • eventStatus integer (values: 0, 1, 2, 3, 1000)
  • id string
  • lastModified string
  • severity integer (values: 0, 1, 2)
  • text string
  • title string

PagedResultsPublicContinuationToken

• PagedResultsPublicContinuationToken object
  • nextPartitionKey string
  • nextRowKey string
  • nextTableName string

PagedResultsPublicOverviewAlert

• PagedResultsPublicOverviewAlert object
  • continuationToken PagedResultsPublicContinuationToken
  • hasMore boolean
  • results array
    • items OverviewAlert

PagedResultsPublicOverviewEvent

• PagedResultsPublicOverviewEvent object
  • continuationToken PagedResultsPublicContinuationToken
  • hasMore boolean
  • results array
    • items OverviewEvent

PersonalCategorySettings

• PersonalCategorySettings object
  • categoryId string
  • hidden boolean
  • mute boolean
  • ringtone string

PlanFeature

• PlanFeature object
  • name string
  • value string

PlanInfo

• PlanInfo object
  • description string
  • display string
  • featureDescription string
  • features array
    • items PlanFeature
  • id string
  • name string
  • upgradeDescription string
  • userAddonKey string

PrepaidBalanceInfo

• PrepaidBalanceInfo object
  • balance integer
  • latestTopUp string
  • pendingTransactions boolean

PrepaidPackageInfo

• PrepaidPackageInfo object
  • code string
  • description string
  • name string
  • prices array
    • items PriceInfo

PrepaidSettingsInfo

• PrepaidSettingsInfo object
  • topUpAmount integer
  • topUpEnabled boolean
  • topUpLimit integer

PrepaidTransactionCreationInfo

• PrepaidTransactionCreationInfo object
  • packageCode string

PrepaidTransactionInfo

• PrepaidTransactionInfo object
  • amount integer
  • autoTopUpId string
  • created string
  • createdBy string
  • currency string
  • modified string
  • packageCode string
  • status string
  • statusCode integer
  • subscriptionId string
  • transactionId string

PriceInfo

• PriceInfo object
  • currency string
  • price integer

RaiseAlertInfo

• RaiseAlertInfo object
  • attachments array
    • items AlertAttachment
  • category string
  • externalId string
  • flags integer
  • parameters array
    • items EventParameterInfo
  • severity integer (values: 0, 1, 2)
  • text required string
  • title required string

ScheduleInfo

• ScheduleInfo object
  • end string
  • id string
  • options integer
  • start string
  • userId string

ScriptDescriptionData

• ScriptDescriptionData object
  • description string
  • name string
  • scriptType string
  • shortDescription string

ScriptInstanceCustomUserData

• ScriptInstanceCustomUserData object
  • customScriptDescription string
  • customScriptName string
  • instanceId string
  • scriptName string

ScriptInstanceDetails

• ScriptInstanceDetails object
  • config object
  • customScriptDescription string
  • customScriptName string
  • enabled boolean
  • eventPattern object
  • instanceId string
  • lastModified string
  • runtimeInformation ScriptInstanceInfoRuntimeInformationModel
  • scriptId string
  • scriptName string
  • subscriptionId string

ScriptInstanceInfoRuntimeInformationModel

• ScriptInstanceInfoRuntimeInformationModel object
  • runtimeStatus integer (values: 0, 1, 2, 3, -1)
  • runtimeStatusMessage string

ScriptLocalizationDetail

• ScriptLocalizationDetail object
  • config object
  • data ScriptDescriptionData
  • language string

StringSegment

• StringSegment object
  • buffer string
  • hasValue boolean
  • length integer
  • offset integer
  • value string

SubscriptionAdoptionInfo

• SubscriptionAdoptionInfo object
  • ownerEmail required string

SubscriptionCreationInfo

• SubscriptionCreationInfo object
  • language string
  • name required string
  • ownerEmail required string
  • timezone string

SubscriptionEndpointInfo

• SubscriptionEndpointInfo object
  • address string
  • lastEvent string
  • type integer (values: 0, 1, 2, 3)

SubscriptionFeature

• SubscriptionFeature object
  • name string
  • type integer
  • value string

SubscriptionInfo

• SubscriptionInfo object
  • branchId string
  • country string
  • currency string
  • endpoints array
    • items SubscriptionEndpointInfo
  • externalAccountId string
  • id string
  • name string
  • nextBilling string
  • ownerId string
  • planCode string
  • planState integer
  • referralEnabled boolean
  • status integer
  • teamIds array
    • items string

SubscriptionProfile

• SubscriptionProfile object
  • name string

TeamDutySummaryInfo

• TeamDutySummaryInfo object
  • dutyAssistEnabled boolean
  • dutySummaries array
    • items DutySummaryInfo

TeamInfo

• TeamInfo object
  • id string
  • memberIds array
    • items string
  • name string
  • subscriptionId string
  • timezone string

TeamSetupProgress

• TeamSetupProgress object
  • completedSteps array
    • items string
  • teamId string
  • timestamp string

UserBranchInfo

• UserBranchInfo object
  • branchId string
  • isBranchManager boolean
  • isBranchMember boolean

UserDeliveryStatusInfo

• UserDeliveryStatusInfo object
  • statusCode integer (values: 0, 1, 2, 4, 6, 8, 24, 26, 30, 31, 32)
  • userId string

UserDutyInfo

• UserDutyInfo object
  • lastChange string
  • onDuty boolean
  • onManagerDuty boolean
  • overdue boolean

UserImage

• UserImage object
  • content string
  • contentDispostion string
  • contentEncoding string
  • contentType string
  • lastModified string
  • name string

UserInfo

• UserInfo object
  • colorIndex integer
  • dutyInfos UserDutyInfo
  • id string
  • isDeactivated boolean
  • isInvite boolean
  • mail string
  • name string
  • subscriptionId string

UserLicenseInfo

• UserLicenseInfo object
  • currentUsers integer
  • isFree boolean
  • isTrial boolean
  • licensedUsers integer
  • planCode string

UserLicenseUpdate

• UserLicenseUpdate object
  • currency string
  • interval required integer (values: 0, 1, 4)
  • licensedUsers required integer
  • planId required string

UserSetupProgress

• UserSetupProgress object
  • completedSteps array
    • items string
  • timestamp string
  • userId string

WebhookBaseInfo

• WebhookBaseInfo object: Basic external webhook model for update/creation.
  • extUrl required string: Url to the external webhook. It will receive all outgoing events.

WebhookInfo

• WebhookInfo object: Basic information about an external webhook.
  • extUrl required string: Url to the external webhook. It will receive all outgoing events.
  • id string: Id of the webhook in SIGNL4.
  • subId string: Id of the subscription that is owning the webhook.