Terminal Shipping API
  • Introduction
  • Example Book Shipment Flow
  • Ship with Code
  • Authentication
  • Errors
  • Libraries & Plugins
  • API ENDPOINTS
  • Addresses
    • Create Address
    • Get Addresses
    • Get Address
    • Update Address
    • Validate Address
    • Set Default Sender Address
    • Get Default Sender Address
  • Carriers
    • Get Carriers
    • Get Carrier
    • Enable Carrier
    • Enable Multiple Carriers
    • Disable Carrier
    • Disable Multiple Carriers
    • Drop-off Locations
  • Claims
    • Get Claims
    • Get Claim
    • File Claim
  • HS Codes
    • Get HSCodes
    • Get HSCode Chapters
    • Get HSCode Categories
    • Get HSCode Details
    • Search HSCodes
  • Insurance
    • Get Insurance
    • Get Insurances List
    • Get Insurance Premium
    • Get Insurance Premium Using Parcel Value
    • Purchase Insurance
  • Packaging
    • Create Packaging
    • Update Packaging
    • Get Packaging
    • Terminal Default Packaging
    • Get Specific Packaging
  • Parcels
    • Create Parcel
    • Update Parcel
    • Get Parcels
    • Get Parcel
  • Rates
    • Get Rates for Shipment
    • Get Quotes for Shipment
    • Get Rates for Multi-Parcel Shipment
    • Get Rates
    • Get Rate
  • Simplified HS Codes
    • Get Simplified HSCodes
    • Get Simplified HSCode Chapters
    • Get Simplified HSCode Categories
    • Get Simplified HSCode Details
    • Search Simplified HSCodes
  • Shipments
    • Create Shipment
    • Create Quick Shipment
    • Update Shipment
    • Get Shipments
    • Get Shipments v2
    • Get Shipment
    • Track a Shipment
    • Cancel Shipment
    • Delete Shipment
    • Duplicate Shipment
    • Arrange Pickup & Delivery for Shipment
  • Transactions
    • Get Transactions
    • Get Transaction
  • Users
    • Get User
    • Get Wallet Info
    • Get Wallet Balance
    • Get User Carriers
  • Webhooks
    • Create Webhook
    • Delete Webhook
    • Disable Webhook
    • Enable Webhook
    • Get Webhooks
    • Get Webhook
  • MISCALLANEOUS
    • Carriers Available
    • Carrier Object
    • Cities
    • Countries
    • File Claim Object
    • Parcel Item
    • Quick Shipments
      • Parcel
      • Pickup / Delivery Address
    • Shipment Events
    • Shipment Extras
    • States
    • Webhook Events
      • Handling Webhook Events
    • Volumetric Weight
Powered by GitBook
On this page

Was this helpful?

  1. MISCALLANEOUS

Webhook Events

Here you can find a list of webhook event types along with descriptions of each event.

Event
Description

address.created

This event is triggered when a new address is created.

address.deleted

This event is triggered when an address is deleted.

address.updated

This event is triggered when an existing address is updated.

insurance.failed

This event is triggered when a purchase for insurance coverage fails.

insurance.success

This event is triggered when insurance coverage is purchased for a shipment.

packaging.created

This event is triggered when a new packaging is created.

packaging.updated

This event is triggered when packaging information is updated.

shipment.cancelled

This event is triggered when a shipment is cancelled.

shipment.created

This event is triggered when a new shipment is created.

shipment.in-transit

This event is triggered only once when a new shipment is in-transit.

shipment.updated

This event is triggered when an active shipment is updated. e.g. Shipment is picked up by rider.

shipment.delivered

This event is triggered when a shipment is delivered. e.g, Shipment delivered to destination address

transaction.success

This event is triggered when the transaction charge for a shipment is successful.

transaction.failed

This event is triggered when the transaction charge for a shipment fails.

PreviousStatesNextHandling Webhook Events

Last updated 1 year ago

Was this helpful?