Interface CreateWebhookRequest

Class representation of a Nylas create webhook request.

interface CreateWebhookRequest {
    description?: string;
    notificationEmailAddresses?: string[];
    triggerTypes: WebhookTriggers[];
    webhookUrl: string;
}

Index

Properties

description? notificationEmailAddresses? triggerTypes webhookUrl

Properties

`Optional`description

description?: string

A human-readable description of the webhook destination.

`Optional`notificationEmailAddresses

notificationEmailAddresses?: string[]

The email addresses that Nylas notifies when a webhook is down for a while.

triggerTypes

triggerTypes: WebhookTriggers[]

List of events that triggers the webhook.

webhookUrl

webhookUrl: string

The url to send webhooks to.