# App banner configured (deprecated)

An app banner was configured.

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

## Header parameters:

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

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

  - `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 object that was created.
    Enum: "APP_BANNER_CONFIGURED"

  - `actor` (any, required)

  - `new` (object, required)

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

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

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

  - `new.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.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.

  - `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 assigned licenses to employees"

  - `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: "License assigned"


## Response 2XX fields