Skip to main content

WebhookDispatchCollectionClient

Sub-client for listing webhook dispatches.

Hierarchy

ResourceCollectionClient
- WebhookDispatchCollectionClient

Index

Methods

Properties

Methods

init

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

Overrides ResourceCollectionClient.__init__
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

list

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

List all webhook dispatches of a user.

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.
Returns ListPage[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

Hide Inherited

__init__
list
http_client
params
resource_id
root_client
url