Type Alias CreateEventSubscriptionBody

Body for creating a new event subscription.

type CreateEventSubscriptionBody = {
    enabled?: boolean;
    events: EventSubscriptionEventsSelection;
    name: string;
    teams?: EventSubscriptionTeamsSelection;
    url: string;
}

Properties

enabled?: boolean

If false, the subscription is created inactive and receives no events until it is enabled. Defaults to true.

Which event types the subscription receives

name: string

Name of the subscription. Must contain at least one non-whitespace character.

Which teams' events the subscription receives. Defaults to all teams.

url: string

HTTPS endpoint that receives the events. Must be publicly reachable and contain no username or password.