Відкритий API і вебхуки PeopleForce для кастомних інтеграцій

Способи підключення

Як ви хочете підключитися?

Більшість підключень узагалі не потребують розробників. Почніть з рівня, який підходить вашій команді.

Без розробників: готовий застосунок у Zapier

Наш офіційний застосунок у Zapier має 13 тригерів і 3 дії: найм, звільнення, зміни посади й зарплати, запити на відсутність, прийняті офери. Підключіть його ключем API компанії й виберіть застосунок на іншому боці.

Low-code: ваш власний інструмент автоматизації

n8n, Make або будь-який інструмент, що працює з HTTP, використовує той самий ключ API і ті самі вебхуки. Команди вже так автоматизують прийом рекомендацій, коригування понаднормових і заявки на онбординг.

Ваші розробники: інтеграція, яку ви будуєте

Задокументований REST API, який читає й записує дані про людей, оргструктуру, компенсації, відсутності, облік часу й рекрутинг, з опублікованими специфікаціями OpenAPI. Побудуйте на ньому дашборд, портал чи асистента.

Доступні дані

Які дані можна читати й записувати?

PeopleForce лишається джерелом правди для даних про людей. Усе нижче можна забирати у ваші системи, записувати назад або й те, й інше.

Об'єкт	Читання	Запис	Події вебхуків
Люди й профілі	Так	Так	Найм, оновлення, перший день, звільнення
Оргструктура	Так	Так	Зміни позицій і профілів посад
Компенсації	Так	Так	Зміни зарплати й додаткових виплат
Відсутності	Так	Так	Створення, погодження, відхилення, відкликання, видалення
Понаднормові	Так	Так	Створення, оновлення, погодження, видалення
Облік часу	Так	Так	—
Рекрутинг	Так	Так	Кандидат, вакансія, заявка, рух воронкою, офер
Ефективність	Так	Лише KPI	—
Опитування	Лише v4	—	Запуск опитування

Для даних про зарплати й компенсації ключу потрібен окремий дозвіл. Дані опитувань читаються через новіший API v4, який використовує ключ сервісного акаунта замість ключа компанії.

Повний довідник ендпоінтів і деталі полів

Усе це є в документації для розробників

Документація для розробників

Події

Що відбувається в момент, коли дані змінюються?

Замість того щоб опитувати нас за розкладом, підпишіться на 36 подій — і PeopleForce сам повідомить ваші системи, коли щось сталося.

Підписані доставки

Доставка на ваш HTTPS-ендпоінт. Задайте для нього секрет, і кожна доставка буде підписана HMAC‑SHA256, тож ви зможете перевірити, що вона від нас.

Лог кожної доставки

Кожна доставка записується в лог разом із запитом і відповіддю, і її можна надіслати повторно з екрана налаштувань.

Налаштування в інтерфейсі або через API

Ендпоінти налаштовуються в інтерфейсі, а також їх можна створювати й видаляти через API.

Група	Події
Люди	Створення, оновлення, перший день, звільнення, скасування звільнення
Компенсації	Зміна зарплати, додавання або зміна додаткової виплати, зміна статусу зайнятості
Відсутності	Створення, погодження, відхилення, відкликання, видалення
Понаднормові	Створення, оновлення, погодження, видалення
Рекрутинг	Створення або видалення кандидата, створення вакансії, створення заявки, рух воронкою, прийняття або відхилення оферу
Структура й доступ	Позиції, профілі посад, рядки кастомних таблиць, зовнішні користувачі, запуск опитування

Як це працює

Як це працює від початку до кінця

Один новий співробітник, чотири кроки, ніхто нічого не передруковує.

1. Додано нового співробітника

HR заповнює профіль у PeopleForce, як і зараз.

2. PeopleForce надсилає подію

Ваш ендпоінт отримує підписаний вебхук з даними людини і датою виходу.

3. Ваші системи реагують

Створюються акаунти, відкривається заявка на ноутбук, надаються доступи.

4. Результат повертається

Ваш процес записує дані акаунтів назад у профіль через API.

З чого почати

Ключ належить компанії, тож ніщо не залежить від того, чи залишиться з вами одна людина.

1. Створіть ключ API

Налаштування → Ключі API, доступно будь-якій ролі, якій ви дали це налаштування. Ключ показується один раз і належить компанії, а не людині, яка його створила.

2. Викличте перший ендпоінт

Передайте ключ у заголовку запиту й прочитайте дані про людей, відділи чи вакансії.

3. Підпишіться на потрібні події

Адміністратор додає ендпоінт вебхука, вибирає його теми й перевіряє лог доставок.

Зараз 300 запитів на хвилину на ключ	Цього досить, щоб щоночі синхронізувати кілька тисяч людей. Якщо перевищити ліміт, відповідь підкаже, скільки чекати перед повтором.
Кожен ключ можна прив'язати до ваших адрес	Додайте до ключа IP allowlist, і він працюватиме лише з ваших серверів.
Специфікація опублікована	Згенеруйте клієнт вашою мовою програмування замість того, щоб писати кожен запит вручну.
Старі версії лишаються доступними	Версії з першої по третю мають однакові шляхи, тож інтеграція, написана під ранішу, продовжує працювати. Версія чотири — окремий, новіший API, на який переходять, коли потрібне те, що вона додає.

Часті питання

Пакети, ключі, версії та інструменти автоматизації.

Відкритий REST API і вебхуки