Skip to main content

WebhookClient

apify_client.clients.WebhookClient

Sub-client for manipulating a single webhook.

Index

Methods

delete

  • delete(): None

dispatches

  • dispatches(): WebhookDispatchCollectionClient

get

  • get(): dict | None

test

  • test(): dict | None

update

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

  • Parameters

    • event_types: list[WebhookEventType] | None = Nonekeyword-only

      List of event types that should trigger the webhook. At least one is required.

    • request_url: str | None = Nonekeyword-only

      URL that will be invoked once the webhook is triggered.

    • payload_template: str | None = Nonekeyword-only

      Specification of the payload that will be sent to request_url

    • headers_template: str | None = Nonekeyword-only

      Headers that will be sent to the request_url

    • actor_id: str | None = Nonekeyword-only

      Id of the Actor whose runs should trigger the webhook.

    • actor_task_id: str | None = Nonekeyword-only

      Id of the Actor task whose runs should trigger the webhook.

    • actor_run_id: str | None = Nonekeyword-only

      Id of the Actor run which should trigger the webhook.

    • ignore_ssl_errors: bool | None = Nonekeyword-only

      Whether the webhook should ignore SSL errors returned by request_url

    • do_not_retry: bool | None = Nonekeyword-only

      Whether the webhook should retry sending the payload to request_url upon failure.

    • is_ad_hoc: bool | None = Nonekeyword-only

      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

    The updated webhook