Webhooks send HTTP POST notifications to an endpoint when selected events occur in Orbit. Use them to keep an external integration up to date with changes to vehicles, carriers and other records.
Choose Create Webhook, enter a name and the destination URL, then choose the events your integration needs. You can search for an event or browse the groups.
Save the subscription
Choose Create. The webhook appears in the list with its subscribed events. Open its delivery log to review delivery attempts.
In the event selector, events about Sequences appear under Sequence. Select each event separately to subscribe to it.
Event
Information in the notification
sequence-created
The Sequence that was created
sequence-updated
The Sequence as it is after the change
sequence-invocation-created
The run that started when the Sequence was launched for a Tour
sequence-invocation-action-created
One step of that run, such as the carriers it selected, an offer it sent or the end of the run
Orbit sends sequence-updated after every saved change to a Sequence:
an edit, in Orbit MissionControl or through the Orbit API
activating or deactivating it
a document added to or removed from one of its properties
a change of its rank, its place in automatic dispatch, through the Orbit API
converting a simple Sequence into one built from SequenceBricks, through the Orbit API
Placing a Sequence at a position in automatic dispatch renumbers the other ranked Sequences, so you receive one notification for every Sequence whose rank changed. A request that changes nothing, such as saving a Sequence without changes or activating a Sequence that is already active, sends no notification.
Northstar Distribution subscribes to vehicle-created and vehicle-deleted so its fleet register can add vehicles and remove them when they leave Orbit. It also subscribes to carrier-created to update its carrier directory, and to sequence-updated so its dispatch dashboard shows which Sequences are active.
Can I subscribe to every event?
Yes. Select the events your integration needs in the event selector. You can change the selection later by editing the webhook.
Where can I check delivery attempts?
Open the webhook in Orbit MissionControl and choose Delivery Log.
Can I change a webhook after creating it?
Yes. Edit the webhook to change its destination, authentication or selected events.
Why did one change send several sequence-updated notifications?
Placing a Sequence at a position in automatic dispatch renumbers the other ranked Sequences. Every Sequence whose rank changed sends its own sequence-updated, so your integration sees each Sequence as it is now.
