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

ParametersTypeDescription
event_typeOptional[WebhookSubscription.EventType]

Event type. Refer to the EventType page for more information on the available event_type values.

pool_idOptional[str]

The ID of a subscribed pool.

id_ltOptional[str]

Subscriptions with IDs less than the specified value.

id_lteOptional[str]

Subscriptions with IDs less than or equal to the specified value.

id_gtOptional[str]

Subscriptions with IDs greater than the specified value.

id_gteOptional[str]

Subscriptions with IDs greater than or equal to the specified value.

created_ltOptional[datetime]

Subscriptions created before the specified date.

created_lteOptional[datetime]

Subscriptions created before or on the specified date.

created_gtOptional[datetime]

Subscriptions created after the specified date.

created_gteOptional[datetime]

Subscriptions created after or on the specified date.

sortUnion[List[str], WebhookSubscriptionSortItems, None]

Sorting options. Default: None.

limitOptional[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
OverviewGetting API keyQuick start
Recipes
Reference
toloka.client
toloka.async_client
toloka.autoquality [autoquality]
toloka.metrics
toloka.streaming