AngelCam rts_notification_rules API

openapi: 3.0.0
info:
  version: 2026.06.11
  title: Angelcam active-service rts_notification_rules API
  contact:
    email: support@angelcam.com
  x-logo:
    url: ./assets/logo-angelcam.svg
  description: 'Angelcam RESTful API — HTTPS only, JSON, all URLs require a trailing slash. See the [developer docs](/) for quickstart, authentication, and key concepts.

    '
servers:
- url: https://api.angelcam.com/v1
tags:
- name: rts_notification_rules
  x-displayName: Notification rules
  description: 'Endpoints for managing notification rules. Notification rule is a rule that defines when and how we should send message to user. For example, we can create rule that says: "When camera goes offline, send me an email".

    '
paths:
  /rts/notifications/rules/:
    get:
      operationId: rts-notifications-rules
      summary: Retrieve notifications rules
      tags:
      - rts_notification_rules
      description: Retrieves list of user notification rules
      parameters:
      - name: limit
        in: query
        required: false
        description: 'Limit result set. Example: `1`.'
        schema:
          type: integer
          minimum: 1
      - name: offset
        in: query
        required: false
        description: 'Return results starting at `offset`. Example: `10`.'
        schema:
          type: integer
          minimum: 0
      security:
      - OAuth2:
        - notifications_rules_access
      - PersonalAccessToken: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationRuleListResponse'
        '400':
          $ref: '#/components/responses/Error400InvalidParams'
        '401':
          $ref: '#/components/responses/Error401Unauthorized'
        '403':
          $ref: '#/components/responses/Error403PermissionDenied'
    post:
      operationId: rts-notification-rule-create
      summary: Create notification rule
      description: Create notification rule
      tags:
      - rts_notification_rules
      security:
      - OAuth2:
        - notifications_rules_manage
      - PersonalAccessToken: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationRuleChangeObject'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationRuleObject'
        '400':
          $ref: '#/components/responses/Error400InvalidParams'
        '401':
          $ref: '#/components/responses/Error401Unauthorized'
        '403':
          $ref: '#/components/responses/Error403PermissionDenied'
  /rts/notifications/rules/{rule_id}/:
    get:
      operationId: rts-notification-rule-detail
      summary: Retrieve notification rule detail
      description: Retrieve notification rule detail
      tags:
      - rts_notification_rules
      security:
      - OAuth2:
        - notifications_rules_access
      - PersonalAccessToken: []
      parameters:
      - $ref: '#/components/parameters/notificationRuleId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationRuleObject'
        '401':
          $ref: '#/components/responses/Error401Unauthorized'
        '403':
          $ref: '#/components/responses/Error403PermissionDenied'
        '404':
          $ref: '#/components/responses/Error404NotFound'
    put:
      operationId: rts-notification-rule-update
      summary: Update notification rule
      description: Update notification rule
      tags:
      - rts_notification_rules
      security:
      - OAuth2:
        - notifications_rules_manage
      - PersonalAccessToken: []
      parameters:
      - $ref: '#/components/parameters/notificationRuleId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationRuleChangeObject'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationRuleObject'
        '400':
          $ref: '#/components/responses/Error400InvalidParams'
        '401':
          $ref: '#/components/responses/Error401Unauthorized'
        '403':
          $ref: '#/components/responses/Error403PermissionDenied'
        '404':
          $ref: '#/components/responses/Error404NotFound'
components:
  schemas:
    NotificationRuleChangeObject:
      type: object
      title: Http notification rule object
      properties:
        notification_method:
          type: integer
          description: notification method ID
        message_type:
          type: string
          enum:
          - my_incident
          - shared_incident
          - arming
          - trigger_action
          - open_incident_verification
          - verify_incident
          - close_incident
          - arrow_status_online
          - arrow_status_offline
          - camera_status_online
          - camera_status_offline
          description: message type to send notification for
        allowed_cameras:
          type: array
          items:
            type: integer
            description: 'List of camera IDs that are allowed to send notifications.

              Allowed only for `camera_status_online` and `camera_status_offline` message types.

              When empty, all cameras are allowed.

              '
        allowed_arrow_clients:
          type: array
          items:
            type: string
            format: uuid
            description: 'List of Arrow client UUIDs that are allowed to send notifications.

              Allowed only for `arrow_status_online` and `arrow_status_offline` message types.

              When empty, all Arrow clients are allowed.

              '
      required:
      - notification_method
      - message_type
      example:
        id: 85
        notification_method: 254
        message_type: camera_status_online
        allowed_cameras:
        - 1
        - 2
        - 3
    ErrorGeneric:
      type: object
      title: Error object
      properties:
        title:
          type: string
        detail:
          type: string
        status:
          type: integer
      required:
      - title
      - detail
      - status
    Error400InvalidParams:
      type: object
      title: Error 400 Invalid Parameters
      properties:
        title:
          type: string
        detail:
          type: object
        status:
          type: integer
      required:
      - title
      - detail
      - status
      example:
        title: invalid
        detail:
        - refresh_rate:
          - valid number is required.
          - Ensure this value is greater than 0.
        - max_width:
          - valid number is required.
          - Ensure this value is greater than or equal to 1.
        status: 400
    NotificationRuleObject:
      type: object
      title: Http notification rule object
      properties:
        id:
          type: integer
          minimum: 1
          description: notification rule ID
        notification_method:
          type: integer
          description: notification method ID
        message_type:
          type: string
          enum:
          - my_incident
          - shared_incident
          - arming
          - trigger_action
          - open_incident_verification
          - verify_incident
          - close_incident
          - arrow_status_online
          - arrow_status_offline
          - camera_status_online
          - camera_status_offline
          description: message type to send notification for
        allowed_cameras:
          type: array
          items:
            type: integer
            description: 'List of camera IDs that are allowed to send notifications.

              Allowed only for `camera_status_online` and `camera_status_offline` message types.

              When empty, all cameras are allowed.

              '
        allowed_arrow_clients:
          type: array
          items:
            type: string
            format: uuid
            description: 'List of Arrow client UUIDs that are allowed to send notifications.

              Allowed only for `arrow_status_online` and `arrow_status_offline` message types.

              When empty, all Arrow clients are allowed.

              '
      required:
      - id
      - notification_method
      - message_type
      example:
        id: 85
        notification_method: 254
        message_type: camera_status_online
        allowed_cameras:
        - 1
        - 2
        - 3
    Error403PermissionDenied:
      allOf:
      - $ref: '#/components/schemas/ErrorGeneric'
      title: Error 403 Permission Denied
      example:
        title: permission_denied
        detail: You do not have permission to perform this action.
        status: 403
    Error401Unauthorized:
      allOf:
      - $ref: '#/components/schemas/ErrorGeneric'
      title: Error 401 Unauthorized
      example:
        title: not_authenticated
        detail: Authentication credentials were not provided
        status: 401
    Error404NotFound:
      allOf:
      - $ref: '#/components/schemas/ErrorGeneric'
      title: Error 404 Not Found
      example:
        title: not_found
        detail: Not Found
        status: 404
    NotificationRuleListResponse:
      type: object
      title: Notification rule list
      properties:
        count:
          type: integer
          minimum: 0
          description: Count of all notifications rules
        next:
          format: uri
          description: Next page from pagination
          nullable: true
          type: string
        previous:
          format: uri
          description: Previous page from pagination
          nullable: true
          type: string
        results:
          type: array
          description: List of notification rules
          items:
            $ref: '#/components/schemas/NotificationRuleObject'
      required:
      - count
      - next
      - previous
      - results
      example:
        count: 10
        next: null
        previous: null
        results:
        - id: 85
          notification_method: 254
          message_type: camera_status_online
          allowed_cameras:
          - 1
          - 2
          - 3
  responses:
    Error403PermissionDenied:
      description: Missing permission.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error403PermissionDenied'
    Error404NotFound:
      description: The specified resource was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error404NotFound'
    Error401Unauthorized:
      description: Missing or invalid authorization.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error401Unauthorized'
    Error400InvalidParams:
      description: Query params are invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error400InvalidParams'
  parameters:
    notificationRuleId:
      name: rule_id
      in: path
      required: true
      description: Notification rule ID
      example: 3
      schema:
        type: integer
        minimum: 1
  securitySchemes:
    OAuth2:
      type: oauth2
      description: 'See the Authentication section above for full documentation.

        '
      flows:
        authorizationCode:
          authorizationUrl: https://my.angelcam.com/oauth/authorize/
          tokenUrl: https://my.angelcam.com/oauth/token/
          scopes:
            user_access: Permission to access user information
            user_delete: Permission to delete the current user account
            camera_access: Permission to list cameras and to get details of a specific camera
            camera_create: Permission to create cameras
            camera_manage: Permission to update cameras
            camera_delete: Permission to delete cameras
            camera_guest_access: Permission to access camera guest
            camera_guest_manage: Permission to manage camera guest
            public_cameras_access: Permission to access public cameras
            arrow_client_access: Permission to access Arrow clients
            arrow_client_manage: Permission to manage Arrow clients
            event_access: Permission to access events
            recording_access: Permission to access camera recordings
            recording_start_stop: Permission to start and stop recording on camera
            recording_clips_access: Permission to access recording clips
            recording_clips_create: Permission to create recording clips
            recording_clips_share: Permission to share recording clips
            sensor_access: Permission to list sensors and to get details of a specific sensor
            sensor_manage: Permission to create, update and delete sensors
            broadcasting_access: Permission to see general broadcasting information and access broadcasting streams
            broadcasting_start_stop: Permission to start and stop public broadcasting on camera
            client_access: Permission to list resellers clients and get details of a specific client
            client_create: Permission to create client account
            client_manage: Permission to update clients detail
            streams_detect: Permission to detect camera streams
            sites_access: Permission to access sites
            sites_manage: Permission to create, update and delete sites
            services_access: Permission to access available services
            trials_access: Permission to access available trials
            trials_activate: Permission to activate a trial
            active_services_access: Permission to access active services
            active_services_manage: Permission to manage active services
            orders_access: Permission to access orders
            messages_access: Permission to access RTS messages
            messages_manage: Permission to manage RTS messages
            incidents_access: Permission to access Incidents
            space_access: Permission to list and activate spaces
            space_permissions_access: Permission to view space permissions
        password:
          tokenUrl: https://api.angelcam.com/oauth/token/
          scopes:
            user_access: Permission to access user information
            user_delete: Permission to delete the current user account
            camera_access: Permission to list cameras and to get details of a specific camera
            camera_create: Permission to create cameras
            camera_manage: Permission to update cameras
            camera_delete: Permission to delete cameras
            camera_guest_access: Permission to access camera guest
            camera_guest_manage: Permission to manage camera guest
            arrow_client_access: Permission to access Arrow clients
            arrow_client_manage: Permission to manage Arrow clients
            event_access: Permission to access events
            recording_access: Permission to access camera recordings
            recording_start_stop: Permission to start and stop recording on camera
            recording_clips_access: Permission to access recording clips
            recording_clips_create: Permission to create recording clips
            recording_clips_share: Permission to share recording clips
            sensor_access: Permission to list sensors and to get details of a specific sensor
            sensor_manage: Permission to create, update and delete sensors
            broadcasting_access: Permission to see general broadcasting information and access broadcasting streams
            broadcasting_start_stop: Permission to start and stop public broadcasting on camera
            client_access: Permission to list resellers clients and get details of a specific client
            client_create: Permission to create client account
            client_manage: Permission to update clients detail
            streams_detect: Permission to detect camera streams
            sites_access: Permission to access sites
            sites_manage: Permission to create, update and delete sites
            services_access: Permission to access available services
            trials_access: Permission to access available trials
            trials_activate: Permission to activate a trial
            active_services_access: Permission to access active services
            active_services_manage: Permission to manage active services
            orders_access: Permission to access orders
            messages_access: Permission to access RTS messages
            messages_manage: Permission to manage RTS messages
            rts_settings_access: Permission to access RTS settings
            rts_settings_manage: Permission to manage RTS settings
            rts_arming_manage: Permission to arm and disarm RTS
            incidents_access: Permission to access Incidents
            space_access: Permission to list and activate spaces
            space_permissions_access: Permission to view space permissions
    PersonalAccessToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'Enter your token as: `PersonalAccessToken {your-token}`

        '
x-tagGroups:
- name: General
  tags:
  - user
  - space
  - location
- name: Camera management
  tags:
  - camera
  - shared-camera
  - camera-guest
  - camera-stream-detection
  - arrow-clients
  - angelcameras
- name: Recording
  tags:
  - recording
  - stream-controls
  - shared-camera-recording
  - clip
  - shared-camera-clip
- name: Broadcasting
  tags:
  - broadcasting
  - public-camera
- name: Events & Sensors
  tags:
  - event
  - sensor
- name: Speaker management
  tags:
  - speakers
  - audio-message
- name: RTS
  tags:
  - incidents
  - rts_settings
  - rts_messages
  - rts_notification_methods
  - rts_notification_rules
- name: Billing
  tags:
  - service
  - active-service
  - order
- name: Clients
  tags:
  - client