Skip to main content

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

linked_resources.equipment

An array of wagons assigned to the train. Always an array, even for a single wagon.

linked_resources.departure_station

The station where the train departs from. null if no departure station is associated.

linked_resources.arrival_station

The station where the train arrives. null if no arrival station is associated.

attributes


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

1

Configure Workflow

In ARMS, create or edit a workflow rule that triggers on train set events.
2

Add Webhook Effect

Add the Train Set Webhook effect to the workflow. Provide your endpoint URL.
3

Map Inputs

Wire the departure station, arrival station, equipment (wagons), and train ID from the trigger event to the effect inputs.
4

Implement Your Endpoint

Build an HTTPS endpoint that receives the POST, verifies the signature, and processes the event.
5

Test

Trigger a test event and confirm your endpoint receives and verifies the payload correctly.

Webhook Overview

Signing, verification, public key, and shared HTTP headers.

Car Actually Placed

Fires when a car is placed at a station or track.

Train Departure

Fires when a train departs from a station or customer location.