Type Alias ListWebhookEventsRequest

ListWebhookEventsRequest: {
    domainId?: string;
    emailId?: string;
    eventTypes?: WebhookEventType[];
    orderBy?: ListWebhookEventsRequestOrderBy;
    organizationId?: string;
    page?: number;
    pageSize?: number;
    projectId?: string;
    region?: Region;
    statuses?: WebhookEventStatus[];
    webhookId: string;
}

Type declaration

  • OptionaldomainId?: string

    ID of the domain to watch for triggering events.

  • OptionalemailId?: string

    ID of the email linked to the events.

  • OptionaleventTypes?: WebhookEventType[]

    List of event types linked to the events.

  • OptionalorderBy?: ListWebhookEventsRequestOrderBy

    (Optional) List Webhook events corresponding to specific criteria.

  • OptionalorganizationId?: string

    ID of the webhook Organization.

  • Optionalpage?: number

    Requested page number. Value must be greater or equal to 1.

  • OptionalpageSize?: number

    Requested page size. Value must be between 1 and 100.

  • OptionalprojectId?: string

    ID of the webhook Project.

  • Optionalregion?: Region

    Region to target. If none is passed will use default region from the config.

  • Optionalstatuses?: WebhookEventStatus[]

    List of event statuses.

  • webhookId: string

    ID of the Webhook linked to the events.

Settings