Provider connections, APIs and webhooks

Understand supported provider types

Follow this guide to choose the type matching the external service.

Audience: Courier operations staffPermission: Courier: Manage integrationsModule v2.0.0
Jump to steps
Where to goAdmin Area → Courier & Logistics → Settings → Providers

What this guide helps you do

Choose the type matching the external service. The instructions below follow the supplied module’s controller, form and model rules, including server-side validation and downstream effects.

Follow these steps

  1. Go to Admin Area → Courier & Logistics → Settings → Providers.
  2. Check the source record and choose the supported action.
  3. Save or submit once, then reopen the record and verify the result.

Fields and options

cxCourier Exchange-style live job/detail/status/POD flow.
custom_jsonConfigurable generic JSON feed/API.
returnloadsReturn-load provider connection.
telematicsLocation/vehicle-oriented provider connection.

Rules and limits

  • Use the supported screen and permission; do not bypass validation or edit database records directly.

Check it worked

  • The source record, status/history and any downstream notification, provider, POD or finance record should agree after the action.

Security, audit and operational checks

  • Use the exact record and least-privilege role before changing any state.
  • Verify the saved record after every action; a browser message alone is not evidence that every downstream step completed.
  • Use protected document and image routes rather than exposing server filesystem paths.
  • Keep customer, driver, provider, financial and credential data within the authorised workflow.
  • For provider, finance, employment, transport and compliance decisions, follow the organisation’s authorised professional process.
Do not bypass the code flowDo not force database values, invent a status, mark a job completed without signed POD evidence, or expose encrypted credentials to make a screen appear successful.