Поняття
Ці терміни використовуються в документації, API та панелі керування. Якщо в панелі щось називається інакше, назву наведено в останньому стовпці.
Два напрямки
Section titled “Два напрямки”| Термін | Що це | У панелі |
|---|---|---|
| Вихідний | Ваша подія йде з Railhook на ендпоінти, які зареєстрували ваші клієнти. Railhook — відправник і підписує те, що надсилає. | Вихідні |
| Вхідний | Вебхук стороннього провайдера надходить у Railhook і далі на призначення, які ви обрали. Railhook — отримувач і перевіряє те, що отримує. | Вхідні |
Вихідний напрямок
Section titled “Вихідний напрямок”| Термін | Що це | У панелі |
|---|---|---|
| Подія | Те, що, за словами вашої системи, сталося, з типом (наприклад, order.completed) і вмістом. Існує незалежно від того, чи хтось її слухає. |
Події |
| Ендпоінт | Адреса, готова приймати події, разом із секретом, з якого обчислюються її підписи. | Ендпоінти |
| Підписка | Постійна заява, що один ендпоінт хоче отримувати події певного типу. | Підписки |
| Зв’язок | Один ендпоінт разом із підписками, що на нього вказують: одиниця, яку ви налаштовуєте, тестуєте й вимикаєте. | Зв’язки |
| Доставка | Зобов’язання донести одну подію до одного ендпоінта, чинне, доки не вдасться або від нього не відмовляться. Одна подія дає по одній доставці на кожну підписку, що збіглася. | Доставки |
| Порядковий номер | Позиція доставки в межах ендпоінта. Використовується, коли ввімкнено впорядкування, щоб доставки на той самий ендпоінт надходили по черзі. | — |
Вхідний напрямок
Section titled “Вхідний напрямок”| Термін | Що це | У панелі |
|---|---|---|
| Джерело | Підключений провайдер разом із тим, що потрібно Railhook, аби довести, що вебхук справді від нього. | Джерела |
| Вхідна подія | Один вебхук, отриманий від джерела, збережений у тому вигляді, в якому надійшов. | Отримані |
| Призначення | Адреса, яку ви обрали для вхідних подій, разом зі способом автентифікації до неї. | У кожному джерелі |
| Пересилання | Зобов’язання донести одну вхідну подію до одного призначення. Вхідний відповідник доставки. | — |
Спроби та відновлення
Section titled “Спроби та відновлення”Спільні для обох напрямків.
| Термін | Що це | У панелі |
|---|---|---|
| Спроба | Одна спроба доставки чи пересилання: один HTTP-запит і його результат. | Спроби, у кожній доставці |
| Драбина повторів | Скільки чекати перед кожною наступною спробою і скільки спроб буде, перш ніж здатися. Вихідний: 7 спроб з очікуванням 1 хв, 5 хв, 15 хв, 1 год, 6 год, потім 24 год. Вхідний: 5 спроб, до 6 год. | — |
| DLQ | Куди потрапляє доставка чи пересилання, коли драбину повторів вичерпано. Там воно чекає рішення людини. | Невдалі повідомлення (вихідний), Невдалі пересилання (вхідний) |
| Повтор (replay) | Створення нових доставок із вже збережених подій. Повторна спроба — наступна спроба тієї самої доставки, а replay — нова доставка. | Машина часу |
| Тунель | Локальний порт на вашій машині, доступний за публічною адресою, поки CLI лишається під’єднаним. | Тунелі |
Тенантність
Section titled “Тенантність”| Термін | Що це | У панелі |
|---|---|---|
| Організація | Тенант. Усе, чим ви володієте, належить рівно одній організації. | Організація |
| Проєкт | Частина роботи організації. Ендпоінти, джерела та API-ключі належать проєкту. | Проєкт |
Що далі
Section titled “Що далі”Швидкий стартЗастосуйте терміни на ділі: надішліть подію й простежте доставку.
Повторні спроби та невдалі повідомленняВихідна драбина повторів докладно.
ПовторКоли повторювати спробу, а коли робити replay.