Skip to main content

​
prefect.cli.cloud.webhook

Command line interface for working with webhooks

​
Functions

​
ls 

ls()
Fetch and list all webhooks in your workspace

​
get 

get(webhook_id: UUID)
Retrieve a webhook by ID.

​
create 

create(webhook_name: str, description: str = typer.Option('', '--description', '-d', help='Description of the webhook'), template: str = typer.Option(None, '--template', '-t', help='Jinja2 template expression'))
Create a new Cloud webhook

​
rotate 

rotate(webhook_id: UUID)
Rotate url for an existing Cloud webhook, in case it has been compromised

​
toggle 

toggle(webhook_id: UUID)
Toggle the enabled status of an existing Cloud webhook

​
update 

update(webhook_id: UUID, webhook_name: str = typer.Option(None, '--name', '-n', help='Webhook name'), description: str = typer.Option(None, '--description', '-d', help='Description of the webhook'), template: str = typer.Option(None, '--template', '-t', help='Jinja2 template expression'))
Partially update an existing Cloud webhook

​
delete 

delete(webhook_id: UUID)
Delete an existing Cloud webhook
⌘I