Skip to main content
Version: Next

WebhookDispatchCollectionClientAsync

Sub-client for the webhook dispatch collection.

Provides methods to manage webhook dispatches, e.g. list them. Obtain an instance via an appropriate method on the ApifyClientAsync class.

Hierarchy

Index

Methods

Properties

Methods

__init__

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

  • 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

iterate

  • Iterate over all webhook dispatches of a user.

    Simple list does only one API call, possibly not listing all items matching the criteria. This method returns an iterator that is capable of making multiple API calls to retrieve all items matching the criteria.

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

    Parameters

    • optionalkeyword-onlylimit: int | None = None

      How many webhook dispatches to retrieve.

    • optionalkeyword-onlyoffset: int | None = None

      What webhook dispatch to include as first when retrieving the list.

    • optionalkeyword-onlydesc: bool | None = None

      Whether to sort the webhook dispatches in descending order based on the date of their creation.

    • optionalkeyword-onlytimeout: Timeout = 'medium'

      Timeout for the API HTTP request.

    Returns AsyncIterator[WebhookDispatch]

list

Properties

resource_id

resource_id: str | None

Get the resource ID.

Page Options