Type Alias EventExtensions

The availability of the properties depends on the event and the context it was triggered in.

type EventExtensions = {
    actor?: { sub?: string; subType?: string };
    ownerId?: string;
    spaceId?: string;
    topLevelResourceId?: string;
    updates?: unknown;
}
Index

Properties

actor?: { sub?: string; subType?: string }

Specifies the entity performing the action on behalf of another party listed as triggering the action.

Type declaration

  • Optionalsub?: string

    Opaque value identifying impersonating entity.

  • OptionalsubType?: string

    The type of the impersonating entity.

ownerId?: string

Id of the owner of the resource affected by the eventContext.

spaceId?: string

Id of the space related to the action performed on the eventContext.

topLevelResourceId?: string

If the event originated from a sub resource the topLevelResourceId contains the id of the top level resource associated with the sub resource.

updates?: unknown

Might be present if the action is of type "updated" and should contain information about the changes made to the resource.