This document gives detail of Noetic LogistieX Shipping APIs: All-in-one workspace for your shipping requirements.

/webhooks

POST

/webhooks

Webhooks are the notifications about ShipmentOrder and ShipmentStatus events. Under development and coming soon! They are sent as they occur in the platform. Register your webhook endpoint to receive single event or multiple events

Request

Body Params application/json

Example

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "is_enabled": true,
    "config": {
        "auth_type": "BASIC_AUTH",
        "username": "string",
        "password": "string",
        "api_key": "api_key",
        "api_secret": "abdgchfjt123456768",
        "api_key_position": "QUERY",
        "endpoint": "http://example.com",
        "name": "string",
        "events": [
            "*"
        ]
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api-playground.logistiex.com/webhooks' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "is_enabled": true,
    "config": {
        "auth_type": "BASIC_AUTH",
        "username": "string",
        "password": "string",
        "api_key": "api_key",
        "api_secret": "abdgchfjt123456768",
        "api_key_position": "QUERY",
        "endpoint": "http://example.com",
        "name": "string",
        "events": [
            "*"
        ]
    }
}'

Responses

🟢201Successfully created webhook config

application/json

Body

Example

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "is_enabled": true,
    "config": {
        "auth_type": "BASIC_AUTH",
        "username": "string",
        "password": "string",
        "api_key": "api_key",
        "api_secret": "abdgchfjt123456768",
        "api_key_position": "QUERY",
        "endpoint": "http://example.com",
        "name": "string",
        "events": [
            "*"
        ]
    }
}

🟠400Bad Request Error

🟠401JWT Access token is missing or invalid

🟠403Not Authorized to perform this operation

🔴500Internal Service Error

🔴503Service Not Available

Modified at 2024-08-06 13:10:37

/locations/{location_id}/

/webhooks/{webhook_id}/