Get a list of subscriptions
Gets data for multiple active subscriptions.
Request
GET https://toloka.yandex.com/api/v1/webhook-subscriptions
Authorization: OAuth <OAuth token>
GET https://sandbox.toloka.yandex.com/api/v1/webhook-subscriptions
Authorization: OAuth <OAuth token>
Headers
Title | Overview |
---|---|
Authorization | A token for account authorization. Add OAuth as a prefix. |
Title | Overview |
---|---|
Authorization | A token for account authorization. Add OAuth as a prefix. |
Query parameters
Specified in the link after the question mark; separated by &
.
Parameter | Overview |
---|---|
event_type | string Event type. Acceptable values:
|
pool_id | string ID of the pool that subscription information is requested for. |
sort | string Parameters to sort by:
To learn how to configure sorting, see Sorting the list of objects. |
Standard query parameters | limit, id_gt, id_gte, id_lt, id_lte, created_gt, created_gte, created_lt, created_lte |
Parameter | Overview |
---|---|
event_type | string Event type. Acceptable values:
|
pool_id | string ID of the pool that subscription information is requested for. |
sort | string Parameters to sort by:
To learn how to configure sorting, see Sorting the list of objects. |
Standard query parameters | limit, id_gt, id_gte, id_lt, id_lte, created_gt, created_gte, created_lt, created_lte |
Query example
You can set up the display of the list of subscriptions in parts (for example, 10 subscriptions at a time):- Show the first 10 subscriptions, starting with the one with the lowest ID.
- Show the remaining subscriptions (10 at a time) in ascending order.
Response
Contains a list of subscriptions with information about each of them in JSON format.
{
items: [
{
"webhook_url": "https://awesome-requester.com/toloka-webhook",
"event_type": "ASSIGNMENT_CREATED",
"pool_id": "121212",
"id": "webhook-subscription-1",
"created": "2020-02-03T15:00:00"
},
{
"webhook_url": "https://awesome-requester.com/toloka-webhook",
"event_type": "POOL_CLOSED",
"pool_id": "121212",
"id": "webhook-subscription-2",
"created": "2020-02-03T15:00:00"
}
],
has_more: false
}
Parameter | Overview |
---|---|
items[] | array of objects An array of objects with information about the requested subscriptions. |
webhook_url | string The URL that notifications will be sent to. |
event_type | string Event type. Acceptable values:
|
pool_id | string ID of the pool that the subscription was created for. |
id | string ID of the subscription. |
created | string The date and time when the subscription was created (UTC). It uses ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss]. |
has_more | boolean Shows whether the list is complete. Acceptable values:
|
Parameter | Overview |
---|---|
items[] | array of objects An array of objects with information about the requested subscriptions. |
webhook_url | string The URL that notifications will be sent to. |
event_type | string Event type. Acceptable values:
|
pool_id | string ID of the pool that the subscription was created for. |
id | string ID of the subscription. |
created | string The date and time when the subscription was created (UTC). It uses ISO 8601 format: YYYY-MM-DDThh:mm:ss[.sss]. |
has_more | boolean Shows whether the list is complete. Acceptable values:
|