--- title: "GET /alertActions/{actionId}" method: GET path: "/alertActions/{actionId}" tags: ["Actions"] --- # GET /alertActions/{actionId} `GET /alertActions/{actionId}` Retrieve a single alert action. ## Response `200` OK - union - NotificationAction - `id` string — Unique identifier of the alert action. - `createTimestamp` string, date-time — Time at which the alert action was created. - `type` 'notification', required — Alert action type. - `enabled` boolean, required — Denotes if the alert rule action is enabled or not being applied. - `name` string, required - `notes` string - `settings` NotificationActionSettings, required — Settings for sending notifications to a list of users. Each item in the list is the id of the user and if the user wants email, push, and/or webapp notifications sent. - `users` object[], required — List of users to notify. Use `['*']` as the single item to target all users in the account. - `id` string, required — Unique id of the user to notify. Use `'*'` to target all users in the account. - `push` boolean, required — If true, try to notify the user using mobile push notifications. - `email` boolean, required — If true, try to notify the user using email notifications. - `webapp` boolean — If true, try to notify the user using an in-webapp popup notification. Webapp is a first-class channel — a user may opt into webapp only (with `email` and `push` both `false`). Omitting this field is equivalent to `false`. - `rearmSeconds` number — If rearmSeconds are set, any alert that occurs for the alertActionRule within the rearmSeconds period will not be sent via email, push, and/or webapp. Instead, it will appear in /api/v3.0/notifications with the `status` = `throttled` - `maxPerHour` number — If maxPerHour is set, for any alert that occurs for the alertActionRule over the maxPerHour in the last 60 minutes will not be sent via email, push, and/or webapp. Instead, it will appear in /api/v3.0/notifications with the `status` = `throttled` - SmsAction - `id` string — Unique identifier of the alert action. - `createTimestamp` string, date-time — Time at which the alert action was created. - `type` 'sms', required — Alert action type. - `enabled` boolean, required — Denotes if the alert rule action is enabled or not being applied. - `name` string, required - `notes` string - `settings` SmsActionSettings, required — Settings for sending SMS notifications to a list of users. Each item in the list is the id of the user to notify via SMS. - `users` object[], required — List of users to notify via SMS. Use `['*']` as the single item to target all users in the account. - `id` string, required — Unique id of the user to notify via SMS. Use `'*'` to target all users in the account. - SmtpAction - `id` string — Unique identifier of the alert action. - `createTimestamp` string, date-time — Time at which the alert action was created. - `type` 'smtp', required — Alert action type. - `enabled` boolean, required — Denotes if the alert rule action is enabled or not being applied. - `name` string, required - `notes` string - `settings` SmtpActionSettings, required — Settings for sending an alert via SMTP. This alert action is primarily used for monitoring services. - `email` string, email, required — Required - `url` string, required — The ip address or domain name of the mail server are both acceptable. - `port` number, required - `username` string — Check with your monitoring service if this is required. - `password` string — Check with your monitoring service if this is required. - `tls` boolean — If tls is not present in the settings, the default is false - ZulipPrivateAction - `id` string — Unique identifier of the alert action. - `createTimestamp` string, date-time — Time at which the alert action was created. - `type` 'zulipPrivate', required — Alert action type. - `enabled` boolean, required — Denotes if the alert rule action is enabled or not being applied. - `name` string, required - `notes` string - `settings` ZulipPrivateActionSettings, required — Settings for sending a private alert message to a user Zulip. Zulip bots need to be supported by your organization. Bots can be created under `Personal Settings > Bots`. - `apiKey` string, required — The apiKey for your Zulip bot - `email` string, required — The email address for your Zulip bot - `organizationUrl` string, required — The url for your Zulip instance - `user` string, required — The user's Zulip email or user number. - ZulipStreamAction - `id` string — Unique identifier of the alert action. - `createTimestamp` string, date-time — Time at which the alert action was created. - `type` 'zulipStream', required — Alert action type. - `enabled` boolean, required — Denotes if the alert rule action is enabled or not being applied. - `name` string, required - `notes` string - `settings` ZulipStreamActionSettings, required — Settings for sending an alert message to a stream in Zulip. Zulip bots need to be supported by your organization. Bots can be created under `Personal Settings > Bots`. - `apiKey` string, required — The apiKey for your Zulip bot - `email` string, required — The email address for your Zulip bot - `organizationUrl` string, required — The url for your Zulip instance - `stream` string, required — The name or id of a stream. - `topic` string, required — The topic to post the message in. - SlackAction - `id` string — Unique identifier of the alert action. - `createTimestamp` string, date-time — Time at which the alert action was created. - `type` 'slack', required — Alert action type. - `enabled` boolean, required — Denotes if the alert rule action is enabled or not being applied. - `name` string, required - `notes` string - `settings` SlackActionSettings, required — Settings for sending an alert message to Slack. Slack bot apps require the `chat:write` permissions scope. In addition, the bot app will need explicit permission to the channel selected in the settings via the Slack app. - `apiToken` string, required — The Slack apiToken generated for your bot app. - `channel` string, required — The Slack channel for sending alert messages. - WebhookAction - `id` string — Unique identifier of the alert action. - `createTimestamp` string, date-time — Time at which the alert action was created. - `type` 'webhook', required — Alert action type. - `enabled` boolean, required — Denotes if the alert rule action is enabled or not being applied. - `name` string, required - `notes` string - `settings` WebhookActionSettings, required — Settings for sending an alert via a webhook. Currently only POST is supported. - `url` string, required - `auth_token` string — Optional bearer token to be included in the Authorization header when sending the alert to the webhook. - BrivoAction - `id` string — Unique identifier of the alert action. - `createTimestamp` string, date-time — Time at which the alert action was created. - `type` 'brivo', required — Alert action type. - `enabled` boolean, required — Denotes if the alert rule action is enabled or not being applied. - `name` string, required - `notes` string - `settings` BrivoActionSettings, required — Settings for using a Brivo access point by an alert action. Supports Acctivation, Setting an Override and removing an override - `service` 'accessPoint' | 'doorOverride' | 'doorOverrideCancel', required — Which service to use, has to be one of accessPoint, doorOverride, or doorOverrideCancel. There is accessPoint used to activate a brivo accesspoint. doorOverride is used to keep an access point activated either to a specified time or indefinite time. doorOverrideCancel removes the door override. - `oauthId` unknown, required - `accessPointName` unknown, required - `accessPointId` unknown - `brivoOverrideSettings` BrivoOverRideSettings — Optional Field for adding an override values to the access point. Should only be used if adding an override value - `endTimeMode` unknown, required - `behavior` unknown, required - `endTime` unknown - ZendeskAction - `id` string — Unique identifier of the alert action. - `createTimestamp` string, date-time — Time at which the alert action was created. - `type` 'zendesk', required — Alert action type. - `enabled` boolean, required — Denotes if the alert rule action is enabled or not being applied. - `name` string, required - `notes` string - `settings` ZendeskActionSettings, required — Settings for sending an alert message to Zendesk and creating a ticket. - `apiToken` string, required — The API token generated for your Zendesk account. For instructions on how to generate this token, please refer to [this guide](https://support.zendesk.com/hc/en-us/articles/4408889192858-Managing-access-to-the-Zendesk-API#topic_bsw_lfg_mmb). - `email` string, required — The email address associated with your Zendesk account. Please note that this email address does not need to be necessarily tied to a specific user and could belong to any admin or agent. Consider creating a dedicated user for automated interactions to streamline alert management. - `subdomain` string, required — The subdomain associated with your Zendesk account. This should follow the format https://subdomain.zendesk.com. Please provide only the subdomain and not the full URL. For more information on finding your Zendesk subdomain, please refer to [this guide](https://support.zendesk.com/hc/en-us/articles/4409381383578-Where-can-I-find-my-Zendesk-subdomain). - ImmixAction - `id` string — Unique identifier of the alert action. - `createTimestamp` string, date-time — Time at which the alert action was created. - `type` 'immix', required — Alert action type. - `enabled` boolean, required — Denotes if the alert rule action is enabled or not being applied. - `name` string, required - `notes` string - `settings` ImmixActionSettings, required — Settings for sending an Immix alert. - `email` string, email, required — The email address where alert will be delivered. - `url` string, required — Accepts either the IP address or domain name of the mail server. - `port` number, required — The port number used to connect to the mail server. - `username` string — Check with your monitoring service if this is required. - `password` string — Check with your monitoring service if this is required. - `tls` boolean — If TLS is not present in the settings, the default is false - ZapierAction - `id` string — Unique identifier of the alert action. - `createTimestamp` string, date-time — Time at which the alert action was created. - `type` 'zapier', required — Alert action type. - `enabled` boolean, required — Denotes if the alert rule action is enabled or not being applied. - `name` string, required - `notes` string - `settings` ZapierActionSettings, required — Settings for sending an alert via Zapier. Currently only POST is supported. - `url` string, required — The URL for the Zapier webhook to which alerts will be sent. This URL is provided by Zapier. For more information, refer to [Zapier Webhooks](https://help.zapier.com/hc/en-us/articles/8496083355661-How-to-Get-Started-with-Webhooks-by-Zapier#h_01HQ87H8BTMK49GY2RC8C4T59J) and [Trigger Zaps from Webhooks](https://help.zapier.com/hc/en-us/articles/8496288690317-Trigger-Zaps-from-webhooks#h_01HBGES5DW79VEMREX2Z7A0K48). - SentinelAction - `id` string — Unique identifier of the alert action. - `createTimestamp` string, date-time — Time at which the alert action was created. - `type` 'sentinel', required — Alert action type. - `enabled` boolean, required — Denotes if the alert rule action is enabled or not being applied. - `name` string, required - `notes` string - `settings` SentinelActionSettings, required — Settings for sending an alert via a sentinel. Currently only POST is supported. - `url` string, required - `auth_token` string — Optional bearer token to be included in the Authorization header when sending the the alert to Sentinel. - EvalinkTalosAction - `id` string — Unique identifier of the alert action. - `createTimestamp` string, date-time — Time at which the alert action was created. - `type` 'evalinkTalos', required — Alert action type. - `enabled` boolean, required — Denotes if the alert rule action is enabled or not being applied. - `name` string, required - `notes` string - `settings` EvalinkTalosActionSettings, required — Settings for sending an alert via a Evalink Talos. Currently only POST is supported. - `url` string, required - `auth_token` string — Optional bearer token to be included in the Authorization header when sending the the alert to Evalink Talos. - OutputPortAction - `id` string — Unique identifier of the alert action. - `createTimestamp` string, date-time — Time at which the alert action was created. - `type` 'outputPort', required — Alert action type. - `enabled` boolean, required — Denotes if the alert rule action is enabled or not being applied. - `name` string, required - `notes` string - `settings` OutputPortActionSettings, required — Settings for activating an output port alert action when an alert is triggered. - `deviceId` string, required — The device id of the device to which the output port belongs. - `duration` number, required — The duration in seconds for which the device output port should be activated. - `portId` string, required — The device output port id to be activated. - EbusAction - `id` string — Unique identifier of the alert action. - `createTimestamp` string, date-time — Time at which the alert action was created. - `type` 'ebus', required — Alert action type. - `enabled` boolean, required — Denotes if the alert rule action is enabled or not being applied. - `name` string, required - `notes` string - `settings` EbusActionSettings, required — Settings for sending an alert to EBUS. - `email` string, email, required — Required - `url` string, required — The ip address or domain name of the mail server are both acceptable. - `port` number, required - `username` string — Check with ebus if this is required. - `password` string — Check with ebus if this is required. - PlaySpeakerAudioClipAction - `id` string — Unique identifier of the alert action. - `createTimestamp` string, date-time — Time at which the alert action was created. - `type` 'playSpeakerAudioClip', required — Alert action type. - `enabled` boolean, required — Denotes if the alert rule action is enabled or not being applied. - `name` string, required - `notes` string - `settings` PlaySpeakerAudioClipActionSettings, required — Settings that determine where an audio clip is played when an alert is triggered. The clip will be played on the union of: - A fixed list of explicitly defined devices (`devices__in`), and - Optionally, additional triggering devices as defined by `playOnTriggeringDevice`: - **none**: Do not include any triggering device. - **alertActorDevices**: Include the device for which the event was created and from which the alert was generated. - **conditionRuleDevices**: Include the devices that the rule, which created the alert, is filtering on. - `speakerAudioClipId` string, required — The ID of speaker audio clip to play. - `playOnTriggeringDevice` 'none' | 'alertActorDevices' | 'conditionRuleDevices' — Specifies which devices should play the audio clip when the rule is triggered. - `none`: Do not attempt to play audio clips on any devices. - `alertActorDevices`: The device for which the event was created and from which the alert was triggered. - `conditionRuleDevices`: The devices that the rule, which created the alert, is filtering on. - `devices__in` string[] — A list of devices that will always play the audio clip, regardless of the device that triggered the alert. Format: `":"` (e.g., `"camera:10001abcd"`, `"speaker:1001abce"`) ## Other responses - `400` — The supplied object is invalid. Error detail will contain the validation error. - `401` — You are not authenticated. Please authenticate and try again. - `403` — You have no permission to access the specified resource. - `404` — Referenced resource could not be found. - `500` — Something went wrong in the server. Please try again. --- [API](https://skmtc.net/eagleeyenetworks/apis/devices.md) · [All operations](https://skmtc.net/eagleeyenetworks/apis/devices/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eagleeyenetworks/devices/revisions/df57313de545/schema)