Event Overview
The Train Arrival webhook fires when a train arrives at a station in your network. It delivers equipment details, the arrival station, loaded/empty status, the train number, 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 trains arrive at specific locations.
Payload Schema
Field Reference
Top-level Fields
linked_resources.equipment
An array of equipment items on the arriving train. Always an array, even for a single car.linked_resources.event_station
The station where the train arrived.null if no 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.
Differences from Car Actually Placed
Setting Up This Webhook
1
Configure Workflow
In ARMS, create or edit a workflow rule that triggers on train arrival events.
2
Add Webhook Effect
Add the Train Arrival Webhook effect to the workflow. Provide your endpoint URL.
3
Implement Your Endpoint
Build an HTTPS endpoint that receives the POST, verifies the signature, and processes the event.
4
Test
Trigger a test event and confirm your endpoint receives and verifies the payload correctly.
Related
Webhook Overview
Signing, verification, public key, and shared HTTP headers.
Car Actually Placed
Webhook for individual car placement events.
Train Departure
Webhook for train departure events, including customer/serving location.
The
linked_resources.customer_location and linked_resources.serving_location fields are not currently included in the Train Arrival payload, even though the underlying event carries them. They are included in the Train Departure payload.