Topic

API and webhooks

Create scoped API clients, use REST endpoints, idempotency, request logs and signed webhook delivery.

10 connected guidesBilty Management
10 guides
Category

Bilty Management

Code-inspected guidance for Britixo Bilty Management v1.0.0 covering three-step Bilty creation, autosave, issue and transit, finance, bilingual English/Urdu PDFs, tenant branding, QR verification, receiver e-sign/POD, WhatsApp automation, reports, REST API, webhooks and tamper-evident audit evidence.

Open guide →
Guide

Enable or disable the Bilty REST API and webhooks

Enable or disable the Bilty REST API and webhooksUse separate tenant-level master switches for the REST API and outbound webhooks before creating integration credentials.

Bilty ManagementOpen guide →
Guide

Create a Bilty API client

Create a Bilty API clientCreate an API client, capture the newly issued bearer token securely and retain only the server-side token hash afterwards.

Bilty ManagementOpen guide →
Guide

Assign Bilty API scopes, IP allowlist and rate limit

Assign Bilty API scopes, IP allowlist and rate limitRestrict each API client to required scopes, optional source IPs and an appropriate request rate.

Bilty ManagementOpen guide →
Guide

Use bearer authentication with the Bilty API

Use bearer authentication with the Bilty APISend the API client bearer credential to the scoped /bilty_management/api/v1 endpoints and handle denied, expired or rate-limited requests correctly.

Bilty ManagementOpen guide →
Guide

Create a Bilty through the API idempotently

Create a Bilty through the API idempotentlyUse the Bilty creation endpoint with a stable idempotency key so a safe retry does not create a duplicate operational record.

Bilty ManagementOpen guide →
Guide

Use Bilty API read and tracking endpoints

Use Bilty API read and tracking endpointsUse health, Bilties, single Bilty, status, tracking, clients, material types, vehicles and brokers endpoints according to the granted scopes.

Bilty ManagementOpen guide →
Guide

Review Bilty API request logs and revoke a client

Review Bilty API request logs and revoke a clientAudit request IDs, routes and response outcomes, then revoke an API client when access is no longer required.

Bilty ManagementOpen guide →
Guide

Create a signed Bilty webhook

Create a signed Bilty webhookRegister a safe HTTPS webhook endpoint, choose supported event subscriptions and protect the shared signing secret.

Bilty ManagementOpen guide →
Guide

Understand Bilty webhook queue, retry and signing

Understand Bilty webhook queue, retry and signingUnderstand how lifecycle events enter the outbound queue, are signed for delivery and retain retry/log evidence.

Bilty ManagementOpen guide →
Guide

Review the included Bilty OpenAPI contract

Review the included Bilty OpenAPI contractUse docs/openapi.yaml as the packaged contract for integration design, while treating the live enabled routes and client scopes as authoritative at runtime.

Bilty ManagementOpen guide →