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. Webhooks

Get Webhook

Fetch details of a specific webhook.

/webhooks/:webhook_id

GET https://api.terminal.africa/v1/webhooks/:webhook_id

This endpoint allows you to get a list of retrieve an existing webhook.

Path Parameters

Name
Type
Description

webhook_id*

string

Unique webhook_id for specific webhook.

{
    "status": true,
    "message": "Webhook retrieved successfully",
    "data": {
        "status": true,
        "message": "Webhook information",
        "data": {
            "events": [
                "false"
            ],
            "_id": "62a0b6dc28bf3cef7bb936fd",
            "active": false,
            "event": "address.created",
            "live": false,
            "name": "My Test Webhook",
            "url": "https://webhook.site/f80b40b7-8004-4fd9-82c0-40f6ccb41cd1",
            "user": "USER-12568655307",
            "webhook_id": "WA-85241442320",
            "created_at": "2022-06-08T14:49:00.190Z",
            "updated_at": "2022-08-01T11:30:54.678Z",
            "__v": 0,
            "id": "62a0b6dc28bf3cef7bb936fd"
        }
    }
}
PreviousGet WebhooksNextCarriers Available

Last updated 2 years ago

Was this helpful?