Investigations

Start an investigation

An actor triggers this event when they start an investigation.

typestring

Default value: START_INVESTIGATION

Available values: The only valid value is START_INVESTIGATION.

ownersAuditLogUser[]

The list of owners that are being audited in the investigation.

idstring

The user ID.

display_namestring

Optional

The display name of the user.

For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.

emailstring

Optional

The email address of the user.

For privacy reasons, this field is redacted for users outside of your organization. Rarely, it may also be unavailable for technical reasons.

investigation_reasonstring

Optional

Available values:

SECURITY_INVESTIGATION: Security investigation.
COMPLIANCE_INVESTIGATION: Compliance investigation.
OTHER: Other.

contextstring

Optional

The context provided as a rationale for starting the investigation.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "START_INVESTIGATION",
    "owners": [
      {
        "id": "UXoqDbwwSbQ",
        "display_name": "Jane Doe",
        "email": "[email protected]"
      }
    ],
    "investigation_reason": "SECURITY_INVESTIGATION",
    "context": "Reviewing designs created by the marketing team for brand compliance."
  },
  "outcome": ...,
  "context": ...
}

JSON

Investigate a design

An actor triggers this event when they view a specific design during an investigation.

typestring

Default value: INVESTIGATE_DESIGN

Available values: The only valid value is INVESTIGATE_DESIGN.

investigation_idstring

Optional

The ID for the investigation. This is a UUID that represents the investigation.

Example

{
  "id": ...,
  "timestamp": ...,
  "actor": ...,
  "target": ...,
  "action": {
    "type": "INVESTIGATE_DESIGN",
    "investigation_id": "550e8400-e29b-41d4-a716-446655440000"
  },
  "outcome": ...,
  "context": ...
}

JSON