Документация по iSpring Learn

Дерево страниц

Сравнение версий

Старая версия 1

changes.mady.by.user Алина Задина

Сохранено

по сравнению с

Новая версия Текущий

changes.mady.by.user elena.antipova

Сохранено

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

POST  /webhook/subscribe

Параметры запроса

Заголовок 

Описание 

X-Auth-Account-Url (обязательный)

Базовый URL аккаунта, например, https://myaccount.ispringlearn.ru.

X-Auth-Email (обязательный)

Логин пользователя.

X-Auth-Password (обязательный)

Пароль пользователя.

Параметр

Описание

subscriberName(обязательное)

Имя существующего

подписчика 

подписчика.

subscription

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

subscription.subscriptionType

Тип события на которое подписался подписчик: 

  • USER_REGISTERED
  • LEARNERS_ENROLLED_IN_COURSE
  • TRAINING_MEETING_ADDED
  • TRAINING_MEETING_REMOVED
  • TRAINING_MEETING_UPDATED
  • TRAINING_SESSION_PARTICIPANTS_ADDED
  • TRAINING_SESSION_PARTICIPANT_REMOVED
  • COURSE_COMPLETED_SUCCESSFULLY

  • COURSE_ITEM_COMPLETED_SUCCESSFULLY

  • COURSE_STATUS_CHANGED

  • COURSE_ITEM_STATUS_CHANGED

subscription.params

Массив данных с возможными параметрами (фильтрами) по событию:

  • LEARNERS_ENROLLED_IN_COURSE (userIds, courseIds)
  • TRAINING_SESSION_PARTICIPANTS_ADDED (userIds)
  • TRAINING_SESSION_PARTICIPANT_REMOVED (userIds)
  • COURSE_COMPLETED_SUCCESSFULLY (userIds, courseIds)
  • COURSE_ITEM_COMPLETED_SUCCESSFULLY (userIds, courseItemIds)
  • COURSE_STATUS_CHANGED(userIds, courseIds)

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

...

  • COURSE_ITEM_STATUS_CHANGED(userIds, courseItemIds)

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

Блок кода
languagexml
curl --location 'https://api-learn.ispringlearn.ru/webhook/subscribe' \

...


--header 'X-Auth-Account-Url: https://myaccount.ispringlearn.ru' \

...


--header 'X-Auth-Email: email@email.com' \

...


--header 'X-Auth-Password: password' \

...


--header 'Content-Type: application/json' \

...


--header 'Accept: application/json' \

...


--data '{

...


  "subscriberName": "name",

...


  "subscription":

...

 {
    "subscriptionType": "LEARNERS_ENROLLED_IN_COURSE",

...


    "params":

...

        {

...

 [
        {
        	"name": "userIds",

...


        	"value": "[\"d15e8c54-c26f-11ed-b604-0a768b65ead7\", \"d15e8c54-c26f-11ed-b604-0a768b65ead7\"]"

...

        }

    ]

  }

...


        }
    ]
  }

Коды ответов

...

Код

Текст

Описание

200

ОК

Подписка добавлена.

400

Bad Request

Ошибка в

запросе 

запросе.

401

Unauthorized

Ошибка авторизации.

403

Permission Denied

У пользователя нет прав.

404

Subscriber not found

Подписчик не

найден 

найден.