# Browser Extension

Endpoint: POST browser-extension
Version: v1
Security: X-Signature

## Security:

  - `X-Signature` (unknown)
    http bearer

## Header parameters:

  - `X-Signature` (string, required)

## Request body:

  - `application/json` (unknown)
    An employee browser extension was created, updated or deleted.

## Request fields (application/json):

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

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

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

  - `tenantMetadata` (object)
    Key/value metadata set by the partner that manages this tenant.
Only present for tenants managed by a partner. When a partner manages the tenant but has set no metadata, it is present as an empty object rather than omitted or null.
A partner may set at most 10 entries, with keys up to 40 characters and values up to 256 characters.
    Example: {"customerRef":"ACME-001","region":"emea"}

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

  - `type` (string)
    The type of event that occurred.
    Enum: "CREATE", "UPDATE", "DELETE"

  - `category` (string)
    The category of the event.
    Enum: "ENTITY"

  - `description` (string)
    The description of the event. Note: this is subject to change and should not be used to match on this object.
    Example: Browser extension Privacy Badger installed

  - `object` (string)
    The object that was created, updated or deleted.
    Enum: "BROWSER_EXTENSION"

  - `friendlyName` (string)
    The friendly name of this object. Note: this is subject to change and should not be used to match on this object.
    Example: Browser extension

  - `new` (object)
    This object represents an extension in an employee's browser in your organization.

  - `new.id` (string)
    Static identifier for the extension.
    Example: gmbgaklkmjakoegficnlkhebmhkjfich

  - `new.employee` (object)
    This object represents an employee in your organization.

  - `new.employee.id` (string)
    Unique identifier for the employee
    Example: 2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0

  - `new.employee.email` (string)
    Primary email address of the employee
    Example: john.hill@example.com

  - `new.employee.firstName` (string)
    First name of the employee
    Example: John

  - `new.employee.lastName` (string)
    Last name of the employee
    Example: Hill

  - `new.employee.department` (string)
    Department - as provided by connected API integrations
    Example: Security Engineering

  - `new.employee.location` (string)
    Location - as provided by connected API integrations
    Example: New York

  - `new.employee.licensed` (boolean)
    Whether the employee is licensed on the Push platform
    Example: true

  - `new.employee.chatopsEnabled` (boolean)
    Whether the employee has ChatOps enabledDeprecation notice: this value no longer does anything unless you still have access to the legacy Employee chat topics functionality on your account. It will be removed in the next API version.
    Example: true

  - `new.employee.creationTimestamp` (integer)
    When this employee was created, formatted as a UNIX timestamp (in seconds)
    Example: 1698669223

  - `new.browserId` (string)
    Identifier of the employee's Push browser.
    Example: 72d0347a-2663-4ef5-b1c5-df39163f1603

  - `new.browser` (string)
    The browser used by the employee
    Enum: "CHROME", "FIREFOX", "EDGE", "SAFARI", "OPERA", "BRAVE", "ARC", "ISLAND", "PRISMA_ACCESS", "ATLAS", "COMET", "DIA", "UNKNOWN"

  - `new.name` (string)
    Name of the browser extension
    Example: Privacy Badger

  - `new.description` (string)
    Description of the browser extension
    Example: Privacy Badger automatically learns to block invisible trackers.

  - `new.deploymentMode` (string)
    Which method was used to install this extension
    Enum: "MANAGED", "DEVELOPMENT", "MANUAL", "SIDELOAD", "OTHER"

  - `new.permissions` (array)
    Permissions required by the browser extension
    Example: ["activeTab","contextMenus","storage"]

  - `new.hostPermissions` (array)
    Host permissions allow extensions to interact with the URLs matching these patterns.
    Example: ["https://*/*","http://*/*"]

  - `new.version` (string)
    Version of the browser extension
    Example: 3.1.5.2

  - `new.versionName` (string)
    Version number shown to the user
    Example: build rc2

  - `new.enabled` (boolean)
    Whether the browser extension is enabled or not
    Example: true

  - `new.disabledReason` (string)
    Reason why the browser extension was disabled. Null when the extension is enabled.
    Enum: "NEW_PERMISSION_REQUIRED", "UNKNOWN"

  - `new.updateUrl` (string)
    The URL where the browser extension gets updates from
    Example: http://clients2.google.com/service/update2/crx

  - `new.homePageUrl` (string)
    Link to the browser extensions home page
    Example: http://www.eff.org/

## Response 2XX:

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