Databricks SDK for JavaScript
    Preparing search index...

    Interface WebhookNotifications

    interface WebhookNotifications {
        onDurationWarningThresholdExceeded?: Webhook[];
        onFailure?: Webhook[];
        onStart?: Webhook[];
        onStreamingBacklogExceeded?: Webhook[];
        onSuccess?: Webhook[];
    }
    Index

    Properties

    onDurationWarningThresholdExceeded? onFailure? onStart? onStreamingBacklogExceeded? onSuccess?

    Properties

    onDurationWarningThresholdExceeded?: Webhook[]

    An optional list of system notification IDs to call when the duration of a run exceeds the threshold specified for the RUN_DURATION_SECONDS metric in the health field. A maximum of 3 destinations can be specified for the on_duration_warning_threshold_exceeded property.

    onFailure?: Webhook[]

    An optional list of system notification IDs to call when the run fails. A maximum of 3 destinations can be specified for the on_failure property.

    onStart?: Webhook[]

    An optional list of system notification IDs to call when the run starts. A maximum of 3 destinations can be specified for the on_start property.

    onStreamingBacklogExceeded?: Webhook[]

    An optional list of system notification IDs to call when any streaming backlog thresholds are exceeded for any stream. Streaming backlog thresholds can be set in the health field using the following metrics: STREAMING_BACKLOG_BYTES, STREAMING_BACKLOG_RECORDS, STREAMING_BACKLOG_SECONDS, or STREAMING_BACKLOG_FILES. Alerting is based on the 10-minute average of these metrics. If the issue persists, notifications are resent every 30 minutes. A maximum of 3 destinations can be specified for the on_streaming_backlog_exceeded property.

    onSuccess?: Webhook[]

    An optional list of system notification IDs to call when the run completes successfully. A maximum of 3 destinations can be specified for the on_success property.

    Settings

    Member Visibility

    On This Page

    Properties