Швидкий старт

1. Отримайте інстанс

   Railhook Cloud

   Зареєструйтеся на railhook.io/register. Тариф Free дає 10 000 подій на місяць, 3 проєкти, 5 ендпоінтів на проєкт і 7 днів історії.

   Базова адреса API: https://railhook.io.

   Власний сервер

   На машині з Docker:

   curl -fsSL https://railhook.io/install.sh | bash

   Інсталятор перевіряє машину, створює в ~/railhook Compose-файл і .env зі згенерованими секретами та запускає стек. Відкрийте http://localhost і зареєструйтеся. Без поштового сервера перший обліковий запис активний одразу.

   Базова адреса API: http://localhost або http://localhost:<port>, якщо ви встановлювали з --port.

2. Створіть проєкт і API-ключ

   У панелі керування створіть проєкт, відкрийте API-ключі й створіть ключ із рівнем доступу READ_WRITE. Ключ показується один раз (зберігається лише його хеш).

3. Додайте ендпоінт і підпишіть його на подію

   Відкрийте Ендпоінти й додайте URL, на який має надходити вебхук. Потім відкрийте Підписки та підпишіть цей ендпоінт на тип події order.completed.

   Обережно

   Типово Railhook відмовляє приватним і внутрішнім адресам. Вкажіть публічно доступний URL.

4. Надішліть подію

   cURL

   export RAILHOOK_URL=https://railhook.io   # or your own instance, e.g. http://localhost or https://hooks.example.com
   export RAILHOOK_API_KEY=...
   
   curl -X POST "$RAILHOOK_URL/api/v1/events" \
     -H "X-API-Key: $RAILHOOK_API_KEY" \
     -H "Content-Type: application/json" \
     -H "Idempotency-Key: order-12345-completed" \
     -d '{"type":"order.completed","data":{"orderId":"ord_12345","amount":99.99}}'

   Node.js

   import { Railhook } from '@railhook/node';
   
   const client = new Railhook({
     apiKey: process.env.RAILHOOK_API_KEY,
     baseUrl: process.env.RAILHOOK_URL,
   });
   
   const event = await client.events.send({
     type: 'order.completed',
     data: { orderId: 'ord_12345', amount: 99.99 },
   });
   console.log(event.eventId, event.deliveriesCreated);

   Python

   import os
   
   from railhook import Railhook, Event
   
   client = Railhook(
       api_key=os.environ["RAILHOOK_API_KEY"],
       base_url=os.environ["RAILHOOK_URL"],
   )
   
   event = client.events.send(
       Event(type="order.completed", data={"order_id": "ord_12345", "amount": 99.99})
   )
   print(event.event_id, event.deliveries_created)

   PHP

   <?php
   use Railhook\Railhook;
   
   $client = new Railhook(
       apiKey: getenv('RAILHOOK_API_KEY'),
       baseUrl: getenv('RAILHOOK_URL'),
   );
   
   $event = $client->events->send(
       type: 'order.completed',
       data: ['orderId' => 'ord_12345', 'amount' => 99.99],
   );
   echo $event['eventId'];

   Railhook відповідає 201 з eventId і deliveriesCreated (по одній доставці на кожну відповідну підписку). Надсилання відбувається після відповіді на запит.

5. Перевірте доставку

   Відкрийте Доставки. Кожна доставка показує свої спроби з кодом статусу й тілом відповіді вашого ендпоінта. 2xx позначає її як SUCCESS; будь-яку іншу відповідь буде повторено, а доставка без спроб, що лишилися, потрапляє до Недоставлених повідомлень.