WebhookDispatchClientAsync

Sub-client for managing a specific webhook dispatch.

Provides methods to manage a specific webhook dispatch, e.g. get its details. Obtain an instance via an appropriate method on the ApifyClientAsync class.

Hierarchy

• ResourceClientAsync
  • WebhookDispatchClientAsync

Index

Methods

• __init__
• get

Properties

• resource_id

Methods

__init__

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

• Overrides ResourceClientAsync.__init__

  Initialize the resource client.

  ---

  Parameters

  • keyword-onlybase_url: str

    API base URL.

  • keyword-onlypublic_base_url: str

    Public CDN base URL.

  • keyword-onlyhttp_client: HttpClientAsync

    HTTP client for making requests.

  • keyword-onlyresource_path: str

    Resource endpoint path (e.g., 'actors', 'datasets').

  • keyword-onlyclient_registry: ClientRegistryAsync

    Bundle of client classes for dependency injection.

  • optionalkeyword-onlyresource_id: str | None = None

    Optional resource ID for single-resource clients.

  • optionalkeyword-onlyparams: dict | None = None

    Optional default parameters for all requests.

  Returns None

get

• async get(): WebhookDispatch | None

• Retrieve the webhook dispatch.

  https://docs.apify.com/api/v2#/reference/webhook-dispatches/webhook-dispatch-object/get-webhook-dispatch

  ---

  Returns WebhookDispatch | None

  The retrieved webhook dispatch, or None if it does not exist.

Properties

resource_id

resource_id: str | None

Inherited from ResourceClientBase.resource_id

Get the resource ID.