The Event is the primitive, raw event type.

interface Event {
    changeSha: string;
    date: string;
    eventTime: string;
    eventType: EventType;
    id: string;
    message: string;
    repo: string;
    timeCreated: string;
    timeResolved: string;
    title: string;
}

Properties

changeSha: string

SHA of commit that led to this deployment. Applicable only if eventType is deployment, will stay empty otherwise.

Only for deployments.

date: string

Date of event.

eventTime: string

Unix timestamp of event time.

eventType: EventType

The type of event that has happened. Can be change, deployment, or incident.

id: string

The underlying ID taken from the main/head commit ID which is a 40-character SHA1 string.

`387aa161993865e33b2e687ce199c25dde76a805`
message: string

The input body serialized to a string.

repo: string

The Git repository name, such as the name of the API or Git repository that we are measuring metrics for.

`SOMEORG/SOMEREPO`
timeCreated: string

Unix timestamp of creation of original event.

timeResolved: string

Unix timestamp when an incident is handled. Only applicable if eventType is incident. Will stay empty otherwise.

title: string

Used for incident titles.

Only for incidents.