Webhook Formats

In Shipsy, we have several types of webhooks to notify and update clients, customers, and trips with relevant information. Let's break down each category and provide an overview.

Client Level Webhooks

This webhook is triggered for any client 

Default Webhook Payload

This payload includes various fields such as reference numbers, descriptions, phone numbers, delivery times, and more.

On-Demand Webhook Payload

Specifically designed for on-demand scenarios, this payload contains details related to orders, hubs, workers, tracking URLs, and more.

Customer Level Webhooks

These webhooks are used to notify specific customers about the status of their consignments. They are further categorized into Default, Format 1, and Format 2.

Default Customer Webhook Payload

This payload includes information about reference numbers, descriptions, event times, and other relevant data.

Format 1 Customer Webhook Payload

This payload omits some fields but retains critical information such as reference numbers, descriptions, and event times.

Format 2 Customer Webhook Payload

This format focuses on key details like delivery status, document IDs, timestamps, addresses, and more.

Trip Level Webhooks

Trip-level webhooks are used to trigger updates specific to trips. They are further categorised based on the trip's type (First and Last Mile, On-Demand Mile, Middle Mile).

First & Last Mile Webhook Payload

This payload contains information about workers, vehicles, hubs, event types, and pending tasks.

Middle Mile Webhook Payload

This payload contains data about the trip, such as route codes, waybill numbers, workers, vehicles, and current hub information.

On-Demand Mile Webhook Payload

This payload includes details about workers, vehicles, hubs, event times, and associated tasks within the trip.

By understanding these webhook categories and their respective payloads, you can effectively use these notifications to keep clients, customers, and trips up to date with the latest information within the Shipsy system.