ContextQMD
Back to Prefect

webhook

docs/v3/api-ref/python/prefect-cli-cloud-webhook.mdx

3.6.30.dev32.5 KB
Original Source

prefect.cli.cloud.webhook

Manage Prefect Cloud Webhooks.

Functions

webhook_ls <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/webhook.py#L32" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
webhook_ls()

Fetch and list all webhooks in your workspace.

webhook_get <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/webhook.py#L66" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
webhook_get(webhook_id: Annotated[UUID, cyclopts.Parameter(help='The webhook ID to retrieve.')])

Retrieve a webhook by ID.

webhook_create <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/webhook.py#L99" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
webhook_create(webhook_name: Annotated[str, cyclopts.Parameter(help='The name of the webhook.')])

Create a new Cloud webhook.

webhook_rotate <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/webhook.py#L143" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
webhook_rotate(webhook_id: Annotated[UUID, cyclopts.Parameter(help='The webhook ID to rotate.')])

Rotate url for an existing Cloud webhook, in case it has been compromised.

webhook_toggle <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/webhook.py#L166" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
webhook_toggle(webhook_id: Annotated[UUID, cyclopts.Parameter(help='The webhook ID to toggle.')])

Toggle the enabled status of an existing Cloud webhook.

webhook_update <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/webhook.py#L190" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
webhook_update(webhook_id: Annotated[UUID, cyclopts.Parameter(help='The webhook ID to update.')])

Partially update an existing Cloud webhook.

webhook_delete <sup><a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/cli/cloud/webhook.py#L228" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

python
webhook_delete(webhook_id: Annotated[UUID, cyclopts.Parameter(help='The webhook ID to delete.')])

Delete an existing Cloud webhook.