Terms used across the docs, the API and the dashboard. The last column gives the dashboard’s name where it differs.
| Term |
What it is |
In the dashboard |
| Outgoing |
Your event travels out of Railhook to endpoints your customers registered. Railhook is the sender and signs what it sends. |
Outgoing |
| Incoming |
A third-party provider’s webhook travels into Railhook and on to destinations you chose. Railhook is the receiver and verifies what it receives. |
Incoming |
| Term |
What it is |
In the dashboard |
| Event |
Something your system says happened, with a type (such as order.completed) and a payload. It exists whether or not anyone is listening. |
Events |
| Endpoint |
A URL that is willing to receive events, together with the secret its signatures are computed from. |
Endpoints |
| Subscription |
A standing statement that one endpoint wants events of a given type. |
Subscriptions |
| Connection |
One endpoint together with the subscriptions that point at it: the unit you configure, test and turn off. |
Connections |
| Delivery |
The obligation to get one event to one endpoint, held until it succeeds or is abandoned. One event fans out into one delivery per matching subscription. |
Deliveries |
| Sequence number |
An endpoint-scoped position on a delivery, used when ordering is on so deliveries to the same endpoint arrive in order. |
— |
| Term |
What it is |
In the dashboard |
| Source |
A provider you have connected, together with what Railhook needs to prove a webhook came from it. |
Sources |
| Incoming event |
One webhook received from a source, kept exactly as it arrived. |
Received |
| Destination |
A URL you chose to receive incoming events, together with how to authenticate to it. |
On each source |
| Forward |
The obligation to get one incoming event to one destination. The incoming counterpart of a delivery. |
— |
Shared by both directions.
| Term |
What it is |
In the dashboard |
| Attempt |
One try at a delivery or a forward: one HTTP request and what it resolved to. |
Attempts, on each delivery |
| Retry ladder |
How long to wait before each further attempt, and how many attempts there are before giving up. Outgoing: 7 attempts, waiting 1m, 5m, 15m, 1h, 6h, then 24h. Incoming: 5 attempts, waiting 1m, 5m, 15m, 1h. |
— |
| DLQ |
Where a delivery or forward lands once its retry ladder is used up, kept for a person to decide about. |
Failed Messages (outgoing), Failed Forwards (incoming) |
| Replay |
Building fresh deliveries from events already stored. A retry is the next attempt on the same delivery; a replay is a new delivery. |
Time Machine |
| Tunnel |
A local port on your machine made reachable at a public URL for as long as the CLI stays connected. |
Tunnels |
| Term |
What it is |
In the dashboard |
| Organization |
The tenant. Everything you own belongs to exactly one. |
Organization |
| Project |
A division of an organization’s work. Endpoints, sources and API keys belong to a project. |
Project |