Документация Толоки

Получить перечень подписок

Важно

Домен 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_CLOSED — пул закрыт.
  • DYNAMIC_OVERLAP_COMPLETED — появилась агрегированная оценка по динамическому перекрытию.
  • ASSIGNMENT_CREATED — задание создано.
  • ASSIGNMENT_SUBMITTED — задание выполнено и ожидает приемки заказчиком.
  • ASSIGNMENT_SKIPPED — задание было взято в работу, но исполнитель пропустил его и к нему уже не вернется.
  • ASSIGNMENT_EXPIRED — задание было взято в работу, но исполнитель не успел выполнить его за отведенное время или отказался от него до конца срока.
  • ASSIGNMENT_APPROVED — задание выполнено исполнителем и подтверждено заказчиком.
  • ASSIGNMENT_REJECTED — задание выполнено исполнителем, но отклонено заказчиком.

pool_id

string

Идентификатор пула, для которого запрашивается информация о подписках.

sort

string

Параметры для сортировки:

  • id — идентификатор подписки;
  • created — дата создания подписки по UTC в формате ISO 8601: YYYY-MM-DDThh:mm:ss[.sss].

О том, как задать сортировку, читайте на странице Сортировка списка объектов.

Стандартные query-параметры

  • limit (integer — ограничение на количество возвращаемых результатов. По умолчанию — 50, максимум — 300)
  • id_gt (string — объекты с идентификатором больше указанного значения)
  • id_gte (string — объекты с идентификатором больше или равным указанному значению)
  • id_lt (string — объекты с идентификатором меньше указанного значения)
  • id_lte (string — объекты с идентификатором меньше или равным указанному значению)
  • created_gt (string — объекты, выданные или созданные после указанной даты)
  • created_gte (string — объекты, выданные или созданные после указанной даты включительно)
  • created_lt (string — объекты, выданные или созданные до указанной даты)
  • created_lte (string — объекты, выданные или созданные до указанной даты включительно)

Пример запроса

Можно настроить показ перечня подписок частями (например, по 10 подписок):

  1. Показать первые 10 подписок, начиная с подписки с наименьшим идентификатором.
  2. Показывать оставшиеся подписки по 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_CLOSED — пул закрыт.
  • DYNAMIC_OVERLAP_COMPLETED — появилась агрегированная оценка по динамическому перекрытию.
  • ASSIGNMENT_CREATED — задание создано.
  • ASSIGNMENT_SUBMITTED — задание выполнено и ожидает приемки заказчиком.
  • ASSIGNMENT_SKIPPED — задание было взято в работу, но исполнитель пропустил его и к нему уже не вернется.
  • ASSIGNMENT_EXPIRED — задание было взято в работу, но исполнитель не успел выполнить его за отведенное время или отказался от него до конца срока.
  • ASSIGNMENT_APPROVED — задание выполнено исполнителем и подтверждено заказчиком.
  • ASSIGNMENT_REJECTED — задание выполнено исполнителем, но отклонено заказчиком.

pool_id

string

Идентификатор пула, для которого создана подписка.

id

string<

Идентификатор подписки.

created

string

Дата и время по создания подписки (по UTC). Формат даты ISO 8601: YYYY-MM-DDThh:mm:ss[.sss].

has_more

boolean

Полнота списка.

Возможные значения:

  • true — в выдачу включены не все элементы из-за ограничения параметра limit;
  • false — выдача включает в себя исчерпывающий список элементов.