Webhook module
WebhookActions
Bases: BaseAction
Webhook actions
get_webhook(project_id, batch_id=None, workflow_id=None)
Get a webhook for a workflow
Warning
You must provide a batch_id of a workflow_id
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
project_id
|
str
|
ID of the project |
required |
batch_id
|
Optional[str]
|
ID of the batch |
None
|
workflow_id
|
Optional[str]
|
ID of the workflow project |
None
|
Returns:
| Type | Description |
|---|---|
Dict
|
Webhook representation |
setup_webhook(project_id, webhook_url, webhook_header=None, batch_id=None, workflow_id=None, disable_progress_bar=False)
Setup a webhook for a workflow
Warning
If you only set the project_id parameter, the webhook will be set on all batches of the project
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
project_id
|
str
|
ID of the project |
required |
webhook_url
|
str
|
URL to call |
required |
webhook_header
|
Optional[str]
|
Authorization header to set on the webhook requests |
None
|
batch_id
|
Optional[str]
|
ID of the batch |
None
|
workflow_id
|
Optional[str]
|
ID of the workflow project |
None
|
disable_progress_bar
|
Optional[bool]
|
Disable the progress bar display |
False
|
Returns:
| Type | Description |
|---|---|
None
|
None |