Вебхуки — это удобный инструмент, который позволяет получать уведомления об изменениях в Worksection без необходимости постоянных запросов к API.

При возникновении определенных изменений в вашем аккаунте автоматически отправляется небольшой пакет данных на указанную вами HTTP-точку назначения. Вебхуки оповещают о событиях аккаунта, а не пользователя. Также можно подписаться на различные типы событий и указать проекты, по которым вы вы хотите получать данные.

Для создания вебхука зайдите в настройки аккаунта в раздел API. 
В поле Мои вебхуки нажмите Создать.

1. Введите URL, который будет принимать запросы вебхука.
   Он должен возвращать следующий http-ответ: (HTTP status: 200, Header: JSON, Body: {“status”: ​“OK”}) на любой запрос за время до 5 секунд, иначе этот запрос будет считаться ошибочным.
2. Выберите события, по которым будут отправляться запросы на указанный URL.
3. Выберите произвольное количество проектов, по которым будут отправляться события. По умолчанию события будут отправляться по всем проектам.
4. При необходимости укажите http user, http password для подключения через basic access authentication.
5. Проверьте валидность вашего URL — нажмите кнопку Тест. 

Для подтверждения нажмите кнопку Создать.

По умолчанию созданный вебхук будет выключенным. Когда будет нужно – включите его вручную: 

Если указанный URL окажется невалидным, то при включении появится ошибка: 

При необходимости вебхук можно отключить и удалить. 

Вебхук может находиться в трех статусах: 

• Серый – ​“Выключенный”
• Зеленый – ​“Работает”
• Оранжевый – ​“Работает, но имеет неудачные попытки” 

​

Включенный вебхук выглядит так:

При создании проекта на указанный URL прийдет следующее событие:

Метод get_webhooks может быть выполнен с использованием ключа административного API: 

https://youraccount.worksection.com/api/admin/v2/?action=get_webhooks&hash=HASH

или же с использованием OAuth 2.0 токена с scope = administrative:

curl -X GET -H "Authorization: Bearer <token_value>"
https://youraccount.worksection.com/api/oauth2?action=get_webhooks

Пример ответа:

{
    "status": "ok",
    "data": [
        {
            "id": "14",
            "url": "https://eoaerzysr8s23hq.m.pipedream.net",
            "events": "post_task,delete_task,reopen_task",
            "status": "active",
            "projects": "333"
        },
        {
            "id": "16",
            "url": "https://eolb4pffb2s43u.m.pipedream.net",
            "events": "post_task,post_comment,post_project",
            "status": "paused"
        }
    ]
}​

Метод delete_webhooks может быть выполнен с использованием ключа админитративного API: 

https://youraccount.worksection.com/api/admin/v2/?action=delete_webhook&
id=<id>&hash=HASH

или же с использование OAuth2 токена с scope = administrative:

curl -X GET -H "Authorization: Bearer <token_value>"
https://youraccount.worksection.com/api/oauth2?action=delete_webhookd&id=<id>

Пример ответа:

{
    "status": "ok"
}