Webhooks - Shifton Help

Webhooks позволяват на Shifton да изпраща известия в реално време до вашите външни системи при възникване на конкретни събития във вашата компания.

Какво представлява това?

Разделът Webhooks на страницата за разработчици ви позволява да създавате крайни точки на webhook, които получават автоматични известия от Shifton. Когато се случват събития в акаунта ви — като създаване на смяна, регистриране на присъствие на служител или публикуване на разписание — Shifton изпраща пакет с данни до посочения от вас URL адрес. Това премахва необходимостта вашите системи постоянно да проверяват Shifton за актуализации, правейки интеграциите по-бързи и по-ефективни.

Предварителни изисквания

Изискване	Подробности
Роля	Owner
Крайна точка	Публично достъпен URL адрес на вашия сървър за получаване на данни от webhook
Знания	Основно разбиране на HTTP заявки и webhooks (или достъп до разработчик)

Стъпка по стъпка

Достъп до раздела Webhooks

В лявата лента за навигация кликнете Интеграции.

Навигирайте до страницата за разработчици.

Кликнете раздела Уебхукове.

Ако все още не са създадени webhooks, ще видите празно състояние с илюстрация на пъзел.

Създаване на нов Webhook

Кликнете бутона „Нов webhook”.

Попълнете конфигурацията на webhook:

Поле	Описание
URL	URL адресът на крайната точка, до която Shifton ще изпраща данни за събитията
Събития	Изберете кои събития в Shifton трябва да задействат този webhook
Активен	Превключвател за активиране или деактивиране на webhook

Запазете webhook.

Shifton вече ще изпраща HTTP POST заявки до вашия URL адрес при настъпване на избраните събития.

Управление на съществуващи Webhooks

В раздела Webhooks ще видите списък с всички създадени webhooks.

Кликнете върху webhook, за да редактирате конфигурацията му.

Можете да промените URL адреса, да актуализирате избора на събитие или да превключите активния статус.

За да премахнете webhook, използвайте опцията за изтриване.

Тестване на Webhook

След създаване на webhook задействайте съответното събитие в Shifton (например, създайте тестова смяна).

Проверете регистрационните файлове на вашия сървър за крайни точки, за да потвърдите, че данните от webhook са получени.

Ако данните не са пристигнали, проверете дали URL адресът е правилен и публично достъпен.

Права за достъп

Роля	Преглед на Webhooks	Създаване/Редактиране на Webhooks	Изтриване на Webhooks
Owner	Да	Да	Да
	Да	Да	Да
Manager	Не	Не	Не
Служител	Не	Не	Не

Често задавани въпроси

В: Какъв формат използва смянаon за данните от webhook?
О: Webhooks се изпращат като HTTP POST заявки с JSON тяло. Вижте API документацията за точната структура на данните за всеки тип събитие.

В: Мога ли да настроя няколко Уебхукове за едно и също събитие?
О: Да, можете да създадете множество webhooks, които слушат едно и също събитие, всеки насочен към различен URL адрес.

В: Какво се случва, ако сървърът ми не работи, когато се задейства webhook?
О: Ако крайната ви точка е недостъпна, доставката на webhook може да се провали. Проверете API документацията за подробности относно политиките за повторен опит и обработка на грешки.

В: Мога ли да филтрирам Уебхукове, за да се задействат само за конкретни служители или проекти?
О: Изборът на събитие за webhook е обикновено на ниво тип събитие. Ще трябва да филтрирате входящите данни от страна на сървъра, за да обработвате конкретни служители или проекти.

В: Как да защитя крайната точка на моя webhook?
О: Обмислете използването на таен токен или проверка на подпис, за да потвърдите, че входящите заявки наистина идват от Shifton. Вижте API документацията за препоръки за сигурност.

Възможни проблеми и решения

Проблем	Възможна причина	Решение
Webhook не се задейства	Webhook е зададен като неактивен	Редактирайте webhook и се уверете, че превключвателят Активен е включен
Крайната точка връща грешки	URL адресът е неправилен или сървърът не работи	Проверете дали URL адресът е правилен и дали сървърът ви работи и е публично достъпен
Данните не са получени	Защитната стена блокира входящите заявки	Проверете настройките на защитната стена на сървъра, за да разрешите входящи POST заявки от Shifton
Webhook се задейства, но данните са непълни	Избран е грешен тип събитие	Редактирайте webhook и проверете дали са избрани правилните събития
Показва се празно състояние въпреки наличието на webhooks	Страницата не е опреснена	Опреснете раздела Webhooks, за да заредите последните данни
Бутонът „Нов webhook” не е видим	Недостатъчни права	Уверете се, че имате роля Owner