WebhookClientAsync
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 WebhookDispatchCollectionClientAsync
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
keyword-onlyevent_types: list[WebhookEventType] | None = None
keyword-onlyrequest_url: str | None = None
keyword-onlypayload_template: str | None = None
keyword-onlyheaders_template: str | None = None
keyword-onlyactor_id: str | None = None
keyword-onlyactor_task_id: str | None = None
keyword-onlyactor_run_id: str | None = None
keyword-onlyignore_ssl_errors: bool | None = None
keyword-onlydo_not_retry: bool | None = None
keyword-onlyis_ad_hoc: bool | None = None
Returns dict
Async sub-client for manipulating a single webhook.