model_web_hooks

Creates, updates, deletes, gets or lists a model_web_hooks resource.

Overview

Name	model_web_hooks
Type	Resource
Id	databricks_workspace.machinelearning.model_web_hooks

Fields

The following fields are returned by SELECT queries:

listwebhooks

Registry webhooks listed successfully.

Name	Datatype	Description
id	string
model_name	string
creation_timestamp	integer
description	string
events	array
http_url_spec	object
last_updated_timestamp	integer
status	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
listwebhooks	select	deployment_name		This endpoint is in Public Preview.
createwebhook	insert	deployment_name		: This endpoint is in Public Preview.
updatewebhook	update	deployment_name		This endpoint is in Public Preview.
deletewebhook	delete	deployment_name		This endpoint is in Public Preview.
testregistrywebhook	exec	deployment_name		This endpoint is in Public Preview.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)

SELECT examples

listwebhooks

This endpoint is in Public Preview.

SELECT
id,
model_name,
creation_timestamp,
description,
events,
http_url_spec,
last_updated_timestamp,
status
FROM databricks_workspace.machinelearning.model_web_hooks
WHERE deployment_name = '{{ deployment_name }}' -- required;

INSERT examples

createwebhook

: This endpoint is in Public Preview.

INSERT INTO databricks_workspace.machinelearning.model_web_hooks (
data__events,
data__model_name,
data__description,
data__status,
data__job_spec,
data__http_url_spec,
deployment_name
)
SELECT 
'{{ events }}',
'{{ model_name }}',
'{{ description }}',
'{{ status }}',
'{{ job_spec }}',
'{{ http_url_spec }}',
'{{ deployment_name }}'
RETURNING
webhook
;

Manifest

# Description fields are for documentation purposes
- name: model_web_hooks
  props:
    - name: deployment_name
      value: string
      description: Required parameter for the model_web_hooks resource.
    - name: events
      value: required
    - name: model_name
      value: Array of string
    - name: description
      value: string
    - name: status
      value: string
    - name: job_spec
      value: object
    - name: http_url_spec
      value: object

UPDATE examples

updatewebhook

This endpoint is in Public Preview.

UPDATE databricks_workspace.machinelearning.model_web_hooks
SET 
data__id = '{{ id }}',
data__events = '{{ events }}',
data__description = '{{ description }}',
data__status = '{{ status }}',
data__http_url_spec = '{{ http_url_spec }}',
data__job_spec = '{{ job_spec }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required
RETURNING
webhook;

DELETE examples

deletewebhook

This endpoint is in Public Preview.

DELETE FROM databricks_workspace.machinelearning.model_web_hooks
WHERE deployment_name = '{{ deployment_name }}' --required;

Lifecycle Methods

testregistrywebhook

This endpoint is in Public Preview.

EXEC databricks_workspace.machinelearning.model_web_hooks.testregistrywebhook 
@deployment_name='{{ deployment_name }}' --required 
@@json=
'{
"id": "{{ id }}", 
"event": "{{ event }}"
}';