WebhookClient
Index
Methods
delete
Delete the webhook.
https://docs.apify.com/api/v2#/reference/webhooks/webhook-object/delete-webhook
Returns None
dispatches
Get dispatches of the webhook.
https://docs.apify.com/api/v2#/reference/webhooks/dispatches-collection/get-collection
Returns WebhookDispatchCollectionClient
get
Retrieve the webhook.
https://docs.apify.com/api/v2#/reference/webhooks/webhook-object/get-webhook
Returns dict | None
test
Test a webhook.
Creates a webhook dispatch with a dummy payload.
https://docs.apify.com/api/v2#/reference/webhooks/webhook-test/test-webhook
Returns dict | None
update
Update the webhook.
https://docs.apify.com/api/v2#/reference/webhooks/webhook-object/update-webhook
Parameters
optionalkeyword-onlyevent_types: list[WebhookEventType] | None = None
List of event types that should trigger the webhook. At least one is required.
optionalkeyword-onlyrequest_url: str | None = None
URL that will be invoked once the webhook is triggered.
optionalkeyword-onlypayload_template: str | None = None
Specification of the payload that will be sent to request_url.
optionalkeyword-onlyheaders_template: str | None = None
Headers that will be sent to the request_url.
optionalkeyword-onlyactor_id: str | None = None
Id of the Actor whose runs should trigger the webhook.
optionalkeyword-onlyactor_task_id: str | None = None
Id of the Actor task whose runs should trigger the webhook.
optionalkeyword-onlyactor_run_id: str | None = None
Id of the Actor run which should trigger the webhook.
optionalkeyword-onlyignore_ssl_errors: bool | None = None
Whether the webhook should ignore SSL errors returned by request_url.
optionalkeyword-onlydo_not_retry: bool | None = None
Whether the webhook should retry sending the payload to request_url upon failure.
optionalkeyword-onlyis_ad_hoc: bool | None = None
Set to True if you want the webhook to be triggered only the first time the condition is fulfilled. Only applicable when actor_run_id is filled.
Returns dict
Sub-client for manipulating a single webhook.