nylas
    Preparing search index...

    Interface WebhookWithSecret

    Class representing a Nylas webhook with secret.

    interface WebhookWithSecret {
        createdAt: number;
        description?: string;
        id: string;
        notificationEmailAddresses?: string[];
        status: WebhookStatus;
        statusUpdatedAt: number;
        triggerTypes: WebhookTriggers[];
        updatedAt: number;
        webhookSecret: string;
        webhookUrl: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    createdAt description? id notificationEmailAddresses? status statusUpdatedAt triggerTypes updatedAt webhookSecret webhookUrl

    Properties

    createdAt: number

    The time the status field was created, represented as a Unix timestamp in seconds

    description?: string

    A human-readable description of the webhook destination.

    id: string

    Globally unique object identifier.

    notificationEmailAddresses?: string[]

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

    status: WebhookStatus

    The status of the new destination.

    statusUpdatedAt: number

    The time the status field was last updated, represented as a Unix timestamp in seconds.

    triggerTypes: WebhookTriggers[]

    List of events that triggers the webhook.

    updatedAt: number

    The time the status field was last updated, represented as a Unix timestamp in seconds.

    webhookSecret: string

    A secret value used to encode the X-Nylas-Signature header on webhook requests.

    webhookUrl: string

    The url to send webhooks to.

    Settings

    Member Visibility

    On This Page

    Properties