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

GET /webhook-subscriptions

Получает данные по нескольким созданным подпискам.

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

curl -X GET 'https://tasks.yandex.ru/api/v1/webhook-subscriptions' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

import requests

url = "https://tasks.yandex.ru/api/v1/webhook-subscriptions"
headers = {
  'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
}
response = requests.get(url, headers=headers)

print(response.text)

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://tasks.yandex.ru/api/v1/webhook-subscriptions',
  'qs': {},
  'headers': {
    'Authorization': 'OAuth PlaceYourRealOAuthToken_Here'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Заголовки

Заголовок

Описание

Authorization

API-токен для авторизации аккаунта. В качестве префикса добавьте 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].

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

limit

integer

Ограничение на количество возвращаемых результатов. По умолчанию — 20, максимум — 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 подписок

curl -X GET 'https://tasks.yandex.ru/api/v1/webhook-subscriptions?sort=id&limit=10' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

Показать остальные части с сортировкой по возрастанию идентификатора

curl -X GET 'https://tasks.yandex.ru/api/v1/webhook-subscriptions?sort=id&limit=10&id_gt={ID_последней_подписки_из_предыдущего_ответа}' \
     -H 'Authorization: OAuth PlaceYourRealOAuthToken_Here'

Ответ

Содержит перечень подписок с информацией о каждой из них в формате JSON.

Пример ответа
{
  "items": [
    {
      "webhook_url": "https://example.com/webhook",
      "event_type": "ASSIGNMENT_CREATED",
      "pool_id": "121212",
      "id": "webhook-subscription",
      "created": "2020-02-03T15:00:00"
    },
    {
      "webhook_url": "https://example.com/webhook-1",
      "event_type": "POOL_CLOSED",
      "pool_id": "121212",
      "id": "webhook-subscription-1",
      "created": "2020-02-03T15:00:00"
    }
  ],
  "has_more": false
}

Параметр

Описание

items

array of objects

Массив со списком подписок и их свойств.

has_more

boolean

Показывает, является ли список элементов в ответе полным.

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

  • true — не все элементы вошли в ответ из-за ограничений в параметре limit.

    Можно получить остальные результаты с помощью параметров с постфиксами _lt(e) и _gt(e).

    См. подробнее о фильтрации запросов.

  • false — в ответе содержатся все имеющиеся элементы.

Предыдущая
Подписки на события
Следующая
Создать подписку