Databricks SDK for JavaScript
    Preparing search index...

    Interface CreateRegistryWebhookRequest

    Details required to create a registry webhook.

    interface CreateRegistryWebhookRequest {
        description?: string;
        events?: RegistryWebhookEvent[];
        httpUrlSpec?: HttpUrlSpec;
        jobSpec?: JobSpec;
        modelName?: string;
        status?: RegistryWebhookStatus;
    }
    Index

    Properties

    description? events? httpUrlSpec? jobSpec? modelName? status?

    Properties

    description?: string

    User-specified description for the webhook.

    events?: RegistryWebhookEvent[]

    Events that can trigger a registry webhook:

    • MODEL_VERSION_CREATED: A new model version was created for the associated model.

    • MODEL_VERSION_TRANSITIONED_STAGE: A model version’s stage was changed.

    • TRANSITION_REQUEST_CREATED: A user requested a model version’s stage be transitioned.

    • COMMENT_CREATED: A user wrote a comment on a registered model.

    • REGISTERED_MODEL_CREATED: A new registered model was created. This event type can only be specified for a registry-wide webhook, which can be created by not specifying a model name in the create request.

    • MODEL_VERSION_TAG_SET: A user set a tag on the model version.

    • MODEL_VERSION_TRANSITIONED_TO_STAGING: A model version was transitioned to staging.

    • MODEL_VERSION_TRANSITIONED_TO_PRODUCTION: A model version was transitioned to production.

    • MODEL_VERSION_TRANSITIONED_TO_ARCHIVED: A model version was archived.

    • TRANSITION_REQUEST_TO_STAGING_CREATED: A user requested a model version be transitioned to staging.

    • TRANSITION_REQUEST_TO_PRODUCTION_CREATED: A user requested a model version be transitioned to production.

    • TRANSITION_REQUEST_TO_ARCHIVED_CREATED: A user requested a model version be archived.

    httpUrlSpec?: HttpUrlSpec

    External HTTPS URL called on event trigger (by using a POST request).

    jobSpec?: JobSpec

    ID of the job that the webhook runs.

    modelName?: string

    If model name is not specified, a registry-wide webhook is created that listens for the specified events across all versions of all registered models.

    status?: RegistryWebhookStatus

    Enable or disable triggering the webhook, or put the webhook into test mode. The default is ACTIVE:

    • ACTIVE: Webhook is triggered when an associated event happens.

    • DISABLED: Webhook is not triggered.

    • TEST_MODE: Webhook can be triggered through the test endpoint, but is not triggered on a real event.

    Settings

    Member Visibility

    On This Page

    Properties