Skip to main content

Event Overview

The Train Departure webhook fires when a train departs from a station, customer location, or serving location in your network. It delivers equipment details, the departure station, customer and serving location (when applicable), loaded/empty status, the train number, and the associated work order (if any). This webhook supports the “early departure” scenario where a train leaves directly from a customer location rather than the main yard. In that case, customer_location and serving_location are populated so your integration can distinguish between a normal yard departure and a customer-site departure.
This webhook is triggered through ARMS workflow automation. Configure it in your workflow rules to notify external systems when trains depart from specific locations.

Payload Schema


Field Reference

Top-level Fields

linked_resources.equipment

An array of equipment items on the departing train. Each item includes per-car loaded/empty status. Always an array, even for a single car.

linked_resources.event_station

The station where the train departed from. null if no station could be resolved.

linked_resources.customer_location

The customer location associated with the departure, if any. The entire object is null for departures not associated with a customer location (normal yard departures).

linked_resources.serving_location

The serving location associated with the departure, if any. The entire object is null when the departure is not tied to a serving location.

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 Train Arrival

The Train Arrival webhook does not currently include customer_location or serving_location, even though the underlying event carries them. This asymmetry is intentional — if your integration needs location context on both arrival and departure, use the Train Departure webhook for location-aware routing.

Setting Up This Webhook

1

Configure Workflow

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

Add Webhook Effect

Add the Train Departure 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.

Webhook Overview

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

Train Arrival

Webhook for train arrival events at stations.