WebhookCollectionClient

Sub-client for manipulating webhooks.

Index

Methods

• create
• list

Methods

create

• create(*, event_types, request_url, payload_template, headers_template, actor_id, actor_task_id, actor_run_id, ignore_ssl_errors, do_not_retry, idempotency_key, is_ad_hoc): dict

• Create a new webhook.

  You have to specify exactly one out of actor_id, actor_task_id or actor_run_id.

  https://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/create-webhook

  ---

  Parameters

  • keyword-onlyevent_types: list[WebhookEventType]

  • keyword-onlyrequest_url: str

  • 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-onlyidempotency_key: str | None = None

  • keyword-onlyis_ad_hoc: bool | None = None

  Returns dict

list

• list(*, limit, offset, desc): ListPage[dict]

• List the available webhooks.

  https://docs.apify.com/api/v2#/reference/webhooks/webhook-collection/get-list-of-webhooks

  ---

  Parameters

  • keyword-onlylimit: int | None = None

  • keyword-onlyoffset: int | None = None

  • keyword-onlydesc: bool | None = None

  Returns ListPage[dict]