Audit Events Webhook Payload

webhook

https://{your-audit-webhook-url}/

When a webhook subscribes to audit events (auditConfig.eventCodes) and one occurs, the following record is sent as a POST request to the URL you specified. The X-Bobsled-Event-Id header equals the record's logId, so a redelivery can be recognised.

Payload

schemaVersion

number

enum

required

Version of this record shape

Allowed:

timestamp

string

required

ISO 8601 timestamp of the event

logId

string

required

Unique identifier of the event, for deduplication

actor

object

required

Who performed the action

subject

What the action was performed on

request

object | null

The HTTP request behind the action; null for actions Bobsled took on its own

code

string

enum

required

Allowed:

eventName

string

enum

required

Human-readable version of code, such as User logged in

Allowed:

level

string

enum

required

Allowed:

outcome

string

enum

required

Whether the action went through or was refused

Allowed:

details

object

required

Response

200OK