Blowhorn API Documentation
  • Welcome
  • API REFERENCE
    • Authentication
      • Customer Authentication
      • Partner Authentication
    • Orders
      • Shipment Orders
      • Marketplace Orders
      • Cancel Order
      • Order Event
      • Order Event History
      • ETA
      • Delivery Partner Details
      • Order Documents
    • Drivers
      • Available Vehicle Class
      • Driver Availability
      • Payday Loan Eligibility
      • Driver Details
      • Driver Balance
      • Driver Deductions
    • Locations
      • Serviceability
      • Hubs
      • Coverage
      • Location Type
      • Storage Type
      • Location Zone
      • Location
    • WMS Inbound
      • Clients
      • Suppliers
      • Purchase Orders
      • Advance Shipping Notice
      • Goods Receipt Note
    • WMS Outbound
      • Shipping Label
      • Shipping Manifest
    • Inventory
      • Product Group
      • Tracking Level
      • Pack Config
      • SKU
      • Inventory
      • Inventory Transaction
    • Webhooks
      • HMAC Authentication
      • Order Status
      • Trip Status
      • Inventory Status
  • Help
    • FAQ
Powered by GitBook
On this page
  • Configure Webhook
  • Update Webhook configuration
  • Postman Collection

Was this helpful?

  1. API REFERENCE
  2. Webhooks

Inventory Status

API Details for 'Inventory Status' webhook.

Configure Webhook

POST /webhooks/subscribe

Use this api to subscribe to the real time order status updates.

Headers

Name
Type
Description

API_KEY*

string

API key obtained by the customer/partner

{
    "status": "PASS",
    "message": "Webhook configured successfully"
}
{
   "status": "FAIL",
   "message": "Webhook update failed"
}
{
  "webhookId": 13,
  "callbackUrl": "https://myserver.com/send/callback/here",
  "headers": {
      "API_KEY": "bSd74acDFhjzy90vqml"
  },
  "verify_payload": true
}

Event

Topics

updateOrderStatus

Shipment Order status updates

{

"WaybillNo":"c018c43h32", "OrderStatus":"Pending", "CourierComment":null, "StatusDateTime":"2020-07-08T08:12:06.759961+00:00", "ToMobileNumber":"+919898989898", "ToEmail":"abc@xyz.com", "ToName":"My Name", "Client":"ABC", "podDocs":[ "drive.blowhorn.com/SH-1N1LJX7/2180710.JPG", "drive.blowhorn.com/POD_SH-1N1LJX7.PDF" ] }

Update Webhook configuration

PUT /webhooks/update

Use this api to update an existing webhook like callback url, active etc.

Headers

Name
Type
Description

API_KEY

String

API key obtained by the customer/partner

{
   "status": "PASS",
   "message": "Updated the webhook successfully"
}
{
   "status": string,
   "message": string
}
{
    "webhookId": 12,
    "callbackUrl": "https://myserver.com/send/callback/here",
    "headers": {
        "API_KEY": "bSd74acDFhjzy90vqml"
    },
    "is_active": false
}

Postman Collection

We have a Postman collection to make the integration quicker and easier. You can test all our APIs by importing the full API collection through the 'Run in Postman' button and running them in the Postman app.

PreviousTrip StatusNextFAQ

Last updated 3 years ago

Was this helpful?

Run in Postman