# Telemetry rule added

An admin user has added a new telemetry rule.

Endpoint: POST telemetry-rule-added
Version: v1
Security: X-Signature

## Security:

  - `X-Signature` (unknown)
    http bearer

## Header parameters:

  - `X-Signature` (string, required)

## Request fields (application/json):

  - `version` (string, required)
    The version of the event.
    Example: 1

  - `id` (string, required)
    The unique identifier for the event. This can be used as an idempotency key.
    Example: c478966c-f927-411c-b919-179832d3d50c

  - `tenantId` (string, required)
    The unique identifier of the tenant the event belongs to.
    Example: 4f9d2e7a-1b3c-4d5e-8f6a-7c8b9d0e1f2a

  - `timestamp` (integer, required)
    When the event occurred, formatted as a UNIX timestamp (in seconds).
    Example: 1698604061

  - `category` (string, required)
    The category of the event.
    Enum: "AUDIT"

  - `object` (string, required)
    The type of event.
    Enum: "TELEMETRY_RULE_ADDED"

  - `friendlyName` (string, required)
    The friendly name of this object. Note: this is subject to change and should not be used to match on this object.
    Example: Telemetry rule added

  - `description` (string, required)
    The description of the event. Note: this is subject to change and should not be used to match on this object.
    Example: user@example.com added a telemetry rule

  - `actor` (object, required)
    This object contains information about the user that performed the action triggering the audit log.

  - `actor.source` (string, required)
    The source of the action that generated the event.
    Enum: "UI"

  - `actor.email` (string, required)
    The email address of the actor.

  - `actor.sourceIpAddress` (string, required)
    The IP address of the actor.

  - `actor.userAgent` (string, required)
    The user agent of the actor, if available.

  - `actor.role` (string, required)
    The role of the actor.
    Enum: "OWNER", "FULL_ACCESS", "READ_ONLY"

  - `new` (object, required)
    The details of the updated rule.

  - `new.ruleId` (string, required)
    The unique identifier for the rule
    Example: c478966c-f927-411c-b919-179832d3d50c

  - `new.telemetry` (string, required)
    The telemetry that the rule applies to.
    Enum: "BROWSER_EVENT_STORAGE", "FILE_DOWNLOAD_TELEMETRY", "FILE_UPLOAD_TELEMETRY"

  - `new.description` (string, required)
    The description given to the rule.
    Example: Store browser events for engineering team

  - `new.enabled` (boolean, required)
    Whether the rule is enabled.
    Example: true

  - `new.criteria` (object, required)
    The criteria for applying the rule.

  - `new.criteria.employeeGroups` (object)
    Conditions for matching employee groups.

  - `new.criteria.employeeGroups.patterns` (array, required)
    The patterns to match.

  - `new.criteria.employeeGroups.include` (boolean, required)
    Whether the condition is to match the pattern or not, i.e. include or exclude matches.
    Example: true

  - `new.criteria.employeeIds` (object)
    Conditions for matching employee identifiers.

  - `new.settings` (object)
    The settings for the telemetry.

  - `new.lastUpdatedTimestamp` (integer, required)
    When the rule was last updated, formatted as a UNIX timestamp (in seconds).
    Example: 1698604061

## Response 2XX:

  - `2XX` (unknown)
    Return any 2XX status to indicate that the data was received successfully