Event Overview
The Train Set webhook fires when a train consist is defined in ARMS — typically when wagons are assigned to a train with departure and arrival stations. It delivers the wagon list, station details (including names), train identifier, and the associated work order (if any).This webhook is triggered through ARMS workflow automation. Configure it in your workflow rules to notify external
systems when a train consist is set up.
Payload Schema
Field Reference
Top-level Fields
| Field | Type | Required | Description |
|---|---|---|---|
event_type | string | Yes | Always "train_set" for this event. |
event_timestamp | string (ISO 8601) | No | When the event occurred. null if unavailable. |
work_order_id | string | No | ID of the associated work order. null if the event has no work order. |
linked_resources | object | Yes | Equipment, departure station, and arrival station for the train. |
attributes | object | Yes | Event-specific attributes (train identifier). |
linked_resources.equipment
An array of wagons assigned to the train. Always an array, even for a single wagon.| Field | Type | Description |
|---|---|---|
resource_id | integer | Internal equipment identifier. |
car_number | string or null | Railroad car/wagon number (e.g. "GCGO 11111"). |
linked_resources.departure_station
The station where the train departs from.null if no departure station is associated.
| Field | Type | Description |
|---|---|---|
resource_id | integer | Internal station identifier. |
name | string | Human-readable station name. |
grouping_type | string | Type of location (e.g. "station", "track"). |
linked_resources.arrival_station
The station where the train arrives.null if no arrival station is associated.
| Field | Type | Description |
|---|---|---|
resource_id | integer | Internal station identifier. |
name | string | Human-readable station name. |
grouping_type | string | Type of location (e.g. "station", "track"). |
attributes
| Field | Type | Description |
|---|---|---|
train_id | string | Train identifier (e.g. train number or code). |
Example HTTP Request
This is the full HTTP request your endpoint receives:The JSON body is canonically serialized (sorted keys, no extra whitespace) so the signature can be verified
deterministically. See the Webhook Overview for verification
instructions.
Setting Up This Webhook
Add Webhook Effect
Add the Train Set Webhook effect to the workflow. Provide your endpoint URL and authorization token.
Map Inputs
Wire the departure station, arrival station, equipment (wagons), and train ID from the trigger event to the effect
inputs.
Implement Your Endpoint
Build an HTTPS endpoint that receives the POST, verifies the signature, and processes the event.
Related
Webhook Overview
Signing, verification, public key, and shared HTTP headers.
Car Actually Placed
Fires when a car is placed at a station or track.