Skip to content

App banner
Webhook

Request

Security
X-Signature
Headers
X-Signaturestringrequired
Example:X-Signature: t=1492774577,v1=5257a869...
Bodyapplication/json

An app banner event was detected.

versionstring

The version of the event.

Example:"1"
idstring, (uuid)

The unique identifier for the event. This can be used as an idempotency key.

Example:"c478966c-f927-411c-b919-179832d3d50c"
tenantIdstring, (uuid)

The unique identifier of the tenant the event belongs to.

Example:"4f9d2e7a-1b3c-4d5e-8f6a-7c8b9d0e1f2a"
timestampinteger

When the event occurred, formatted as a UNIX timestamp (in seconds).

Example:1698604061
categorystring

The category of the event.

Value:"CONTROL"
descriptionstring

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

The object that was created.

Value:"APP_BANNER"
friendlyNamestring

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"
newobject(App banner)

App banner event details.

POST
app-banner
curl -i -X POST \
  https://api.pushsecurity.com/app-banner \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-Signature: X-Signature: t=1492774577,v1=5257a869...' \
  -d '{}'

Responses

Return any 2XX status to indicate that the data was received successfully