Getting Started with Freight Financials — Webhook Ingestion API

Introduction

Receives real-time event callbacks from freight audit providers (currently Navix) and publishes them to Kafka for downstream processing.

Request Flow

Navix ──POST──▶ APIM ──validates key, stamps X-Tenant-Id──▶ Webhooks API ──publishes──▶ Kafka

1. Navix fires an HTTP callback when an event occurs (invoice created, dispute updated, etc.).
2. Azure API Management (APIM) authenticates the caller via subscription key or OAuth client credentials, then forwards the request with an X-Tenant-Id header identifying the tenant.
3. This service validates the tenant header, deserializes the Navix payload, maps it to a provider-agnostic domain event, and publishes it to a Kafka topic.
4. Downstream consumers (the Events function app) process the domain events asynchronously.

Authentication

This API does not use Entra ID / OAuth for inbound requests. Authentication is handled at the APIM layer.

All requests must include the X-Tenant-Id header. Requests without this header receive a 401 Unauthorized response.

When testing from Swagger UI, click the Authorize button and enter your tenant identifier in the X-Tenant-Id field.

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install apimatic-tql-sdk==0.0.2

You can also view the package at: https://pypi.python.org/pypi/apimatic-tql-sdk/0.0.2

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

Code-Based Client Initialization

import logging

from freightfinancialswebhookingestionapi.configuration import Environment
from freightfinancialswebhookingestionapi.freightfinancialswebhookingestionapi_client import FreightfinancialswebhookingestionapiClient
from freightfinancialswebhookingestionapi.logging.configuration.api_logging_configuration import LoggingConfiguration
from freightfinancialswebhookingestionapi.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from freightfinancialswebhookingestionapi.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration

client = FreightfinancialswebhookingestionapiClient(
    environment=Environment.PRODUCTION,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)

Environment-Based Client Initialization

from freightfinancialswebhookingestionapi.freightfinancialswebhookingestionapi_client import FreightfinancialswebhookingestionapiClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = FreightfinancialswebhookingestionapiClient.from_environment(dotenv_path='/path/to/.env')

See the Environment-Based Client Initialization section for details.

List of APIs

• Assignments
• Documents
• Freight Audit
• Invoices
• Loads
• Rating

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization
• AbstractLogger
• LoggingConfiguration
• RequestLoggingConfiguration
• ResponseLoggingConfiguration

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime