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

Install the gem from the command line:

gem install apimatic-tql-sdk -v 0.0.2

Or add the gem to your Gemfile and run bundle:

gem 'apimatic-tql-sdk', '0.0.2'

For additional gem details, see the RubyGems page for the apimatic-tql-sdk gem.

IRB Console Usage

You can explore the SDK interactively using IRB in two ways

1. Use IRB with Installed Gem

Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.

irb

Now you can load the SDK in the IRB

require 'freight_financials_webhook_ingestion_api'
include FreightFinancialsWebhookIngestionApi

2. Use IRB within SDK

Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.

cd path/to/freight_financials_webhook_ingestion_api

Now you can start the preconfigured irb console by running the following command

ruby bin/console

Note: This automatically loads the SDK from lib/

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter Type Description
connection Faraday::Connection The Faraday connection object passed by the SDK user for making requests
adapter Faraday::Adapter The Faraday adapter object passed by the SDK user for performing http requests
timeout Float The value to use for connection timeout.
Default: 30
max_retries Integer The number of times to retry an endpoint call if it fails.
Default: 0
retry_interval Float Pause in seconds between retries.
Default: 1
backoff_factor Float The amount to multiply each successive retry's interval amount by in order to provide backoff.
Default: 2
retry_statuses Array A list of HTTP statuses to retry.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array A list of HTTP methods to retry.
Default: %i[get put]
http_callback HttpCallBack The Http CallBack allows defining callables for pre and post API calls.
proxy_settings ProxySettings Optional proxy configuration to route HTTP requests through a proxy server.
logging_configuration LoggingConfiguration The SDK logging configuration for API calls

The API client can be initialized as follows:

Code-Based Client Initialization

require 'freight_financials_webhook_ingestion_api'
include FreightFinancialsWebhookIngestionApi

client = Client.new(
  logging_configuration: LoggingConfiguration.new(
    log_level: Logger::INFO,
    request_logging_config: RequestLoggingConfiguration.new(
      log_body: true
    ),
    response_logging_config: ResponseLoggingConfiguration.new(
      log_headers: true
    )
  )
)

Environment-Based Client Initialization

require 'freight_financials_webhook_ingestion_api'
include FreightFinancialsWebhookIngestionApi

# Create client from environment
client = Client.from_env

See the Environment-Based Client Initialization section for details.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities