Skip to main content

WebhookClient

Sub-client for manipulating a single webhook.

Hierarchy

Index

Methods

Properties

Methods

__init__

  • __init__(*, base_url, root_client, http_client, resource_id, resource_path, params): None

  • Initialize a new instance.

    Parameters

    • keyword-onlybase_url: str

      Base URL of the API server.

    • keyword-onlyroot_client: ApifyClient

      The ApifyClient instance under which this resource client exists.

    • keyword-onlyhttp_client: HTTPClient

      The HTTPClient instance to be used in this client.

    • optionalkeyword-onlyresource_id: str | None = None

      ID of the manipulated resource, in case of a single-resource client.

    • keyword-onlyresource_path: str

      Path to the resource's endpoint on the API server.

    • optionalkeyword-onlyparams: dict | None = None

      Parameters to include in all requests from this client.

    Returns None

delete

  • delete(): None

dispatches

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

  • 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

Properties

http_client

http_client: HTTPClient | HTTPClientAsync

params

params: dict

resource_id

resource_id: str | None

root_client

root_client: ApifyClient | ApifyClientAsync

url

url: str
Page Options