Получить перечень подписок
Важно
Домен toloka.yandex.com
работает в режиме deprecated. Рекомендуем переключиться на домен toloka.dev
для запросов API.
Получает данные по нескольким созданным подпискам.
Запрос
GET https://toloka.dev/api/v1/webhook-subscriptions
Authorization: OAuth <OAuth token>
GET https://sandbox.toloka.dev/api/v1/webhook-subscriptions
Authorization: OAuth <OAuth token>
Заголовки
Заголовок | Описание |
---|---|
Authorization | Токен для авторизации аккаунта. В качестве префикса добавьте OAuth. |
Query-параметры
Указываются в ссылке после знака вопроса, перечисляются через &
.
Параметр |
Описание |
event_type |
string Тип события. Возможные значения:
|
pool_id |
string Идентификатор пула, для которого запрашивается информация о подписках. |
sort |
string Параметры для сортировки:
О том, как задать сортировку, читайте на странице Сортировка списка объектов. |
Стандартные query-параметры |
|
Пример запроса
Можно настроить показ перечня подписок частями (например, по 10 подписок):
- Показать первые 10 подписок, начиная с подписки с наименьшим идентификатором.
- Показывать оставшиеся подписки по 10 штук в порядке возрастания.
Показать первые 10 подписок
GET https://toloka.dev/api/v1/webhook-subscriptions?sort=id&limit=10
Authorization: OAuth <OAuth token>
GET https://sandbox.toloka.dev/api/v1/webhook-subscriptions?sort=id&limit=10
Authorization: OAuth <OAuth token>
Показывать остальные части с сортировкой по возрастанию идентификатора
GET https://toloka.dev/api/v1/webhook-subscriptions?sort=id&limit=10&id_gt=<ID of the last subsciption from the previous response>
Authorization: OAuth <OAuth token>
GET https://sandbox.toloka.dev/api/v1/webhook-subscriptions?sort=id&limit=10&id_gt=<ID of the last subsciption from the previous response>
Authorization: OAuth <OAuth token>
Ответ
Содержит перечень подписок с информацией о каждой из них в формате JSON.
{
"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
}
Параметр |
Описание |
items[] |
array of objects Массив объектов с информацией о запрашиваемых подписках. |
webhook_url |
string URL, на который будут приходить уведомления. |
event_type |
string Тип события. Возможные значения:
|
pool_id |
string Идентификатор пула, для которого создана подписка. |
id |
string< Идентификатор подписки. |
created |
string Дата и время создания подписки (по UTC). Формат даты ISO 8601: |
has_more |
boolean Полнота списка. Возможные значения:
|