# App banner

Endpoint: POST app-banner
Version: v1
Security: X-Signature

## Header parameters:

  - `X-Signature` (string, required)
    Example: "X-Signature: t=1492774577,v1=5257a869..."

## 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"

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

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

  - `description` (string)
    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 saw a banner on Google Workspace"

  - `object` (string)
    The object that was created.
    Enum: "APP_BANNER"

  - `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: "App banner"

  - `new` (object)
    This object represents an app banner event, indicating an employee has interacted with an app banner.

  - `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.creationTimestamp` (integer)
    When this employee was created, formatted as a UNIX timestamp (in seconds)
    Example: 1698669223

  - `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.url` (string,null)
    The URL that the banner was shown on. This is null if an app rule was used.
    Example: "https://openai.com"

  - `new.appType` (string,null)
    The app that the banner was configured on. This is null if a URL pattern rule was used.
    Example: "OPENAI"

  - `new.appBanner` (object)
    This object represents an app banner.

  - `new.appBanner.title` (string)
    Title of the app banner.
    Example: "This is a title"

  - `new.appBanner.subtext` (string)
    Subtext of the app banner.
    Example: "This is the subtext that supports limited [markdown](https://markdown.org)"

  - `new.appBanner.mode` (string)
    All possible ENUM values for app banner modes
    Enum: "INFORM", "ACKNOWLEDGE", "REASON", "BLOCK"

  - `new.appBanner.buttonText` (string,null)
    Button text of the app banner. Only applicable when the app banner is in ACKNOWLEDGE or REASON mode, or is in BLOCK mode with allowReasonSubmission set to true.
    Example: "Proceed anyway"

  - `new.appBanner.allowReasonSubmission` (boolean,null)
    Whether the user is allowed to submit a request to access a blocked page. Only applicable when the app banner is in BLOCK mode.

  - `new.appBanner.displayFrequency` (string,null)
    All possible ENUM values for how frequently the app banner is displayed.
    Enum: "ONCE_PER_TAB", "ONCE_PER_BROWSER"

  - `new.action` (string)
    All possible ENUM values for app banner actions
    Enum: "ACKNOWLEDGED", "DISPLAYED", "SUBMITTED_REASON"

  - `new.reason` (string,null)
    Reason provided by the employee for bypassing or requesting access to the app. Applicable when the action is SUBMITTED_REASON.
    Example: "I need to access this app for my work."

  - `new.sourceIpAddress` (string)
    The IP address of the user interacting with the app banner.
    Example: "8.158.25.38"

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

  - `new.os` (any)
    The OS used by the employee
    Enum: "MACOS", "WINDOWS", "LINUX", "CHROME_OS", "IOS", "ANDROID", "UNKNOWN"

  - `new.userAgent` (string)
    The user agent string reported by the browser
    Example: "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36 Edge/16.16299"


## Response 2XX fields