find_webhook_subscriptions

toloka.client.TolokaClient.find_webhook_subscriptions | Source code

Finds webhook subscriptions that match certain criteria.

The number of returned webhook subscriptions is limited. To find remaining webhook subscriptions call find_webhook_subscriptions with updated search criteria.

To iterate over all matching webhook subscriptions you may use the get_webhook_subscriptions method.

Parameters description

Parameters	Type	Description
`event_type`	Optional[WebhookSubscription.EventType]	Event type. Refer to the EventType page for more information on the available `event_type` values.
`pool_id`	Optional[str]	The ID of a subscribed pool.
`id_lt`	Optional[str]	Subscriptions with IDs less than the specified value.
`id_lte`	Optional[str]	Subscriptions with IDs less than or equal to the specified value.
`id_gt`	Optional[str]	Subscriptions with IDs greater than the specified value.
`id_gte`	Optional[str]	Subscriptions with IDs greater than or equal to the specified value.
`created_lt`	Optional[datetime]	Subscriptions created before the specified date.
`created_lte`	Optional[datetime]	Subscriptions created before or on the specified date.
`created_gt`	Optional[datetime]	Subscriptions created after the specified date.
`created_gte`	Optional[datetime]	Subscriptions created after or on the specified date.
`sort`	Union[List[str], WebhookSubscriptionSortItems, None]	Sorting options. Default: `None`.
`limit`	Optional[int]	Returned webhook subscriptions limit. The maximum allowed value: 300.

Returns:

Found webhook subscriptions and a flag showing whether there are more matching webhook subscriptions exceeding the limit.
Return type:

WebhookSubscriptionSearchResult

Examples:

find_result = toloka_client.find_webhook_subscriptions(pool_id='1080020')
subscriptions = find_result.items

Last updated: August 28, 2023

Toloka-Kit

Overview Getting API key Quick start

Recipes

Reference

toloka.client

toloka.async_client

toloka.autoquality [autoquality]

toloka.metrics

toloka.streaming