🔌 What is a Channel?

Understand how external systems connect to Deliverty Hub through channels.

Overview

A channel is an external system that connects to Deliverty Hub to create and manage delivery tasks. Channels serve as the bridge between your application — whether it is an e-commerce platform, an order management system (OMS), a marketplace, or any other software — and the Deliverty delivery network.

When your system needs to dispatch a delivery, it sends a request through its channel to Deliverty Hub. The platform then handles task assignment, courier dispatch, real-time tracking, and status updates, all scoped to the organization the channel belongs to.

Key Concepts

Organization Scoping

Every channel belongs to exactly one organization. This means all tasks created through a channel are automatically scoped to that organization. Couriers, customers, and data from one organization are completely isolated from another — this is the foundation of Deliverty Hub's multi-tenant architecture.

Channel Identity

Each channel has the following properties:

Property Description
name A human-readable name for the channel (e.g., "Shopify Store", "WooCommerce")
description An optional description explaining the channel's purpose
status Current state: ACTIVE, INACTIVE, or SUSPENDED
userId The user account associated with this channel for API authentication
organizationId The organization this channel belongs to

Channel Statuses

A channel can be in one of three states:

  • ACTIVE — The channel can send API requests and create tasks. This is the default state after creation.
  • INACTIVE — The channel is disabled. API requests will be rejected. Useful for temporarily pausing an integration.
  • SUSPENDED — The channel has been suspended by an administrator, typically due to policy violations or billing issues. API requests will be rejected.

How Channels Work

1

Admin creates a channel

An organization administrator creates a channel in the Deliverty Hub dashboard and generates API credentials.

2

Developer integrates

The developer receives the API key and integrates their application with the Deliverty Hub REST API.

3

Channel sends tasks

The external system sends delivery tasks through the API. Each request includes the x-api-key header for authentication.

4

Deliverty processes

Deliverty Hub validates the request, creates the task within the channel's organization, and begins the delivery workflow.

Common Use Cases

🛒
E-Commerce Platforms
Connect Shopify, WooCommerce, or custom storefronts to automatically dispatch deliveries when orders are placed.
📋
Order Management Systems
Integrate your OMS to route delivery tasks based on order type, priority, and location.
📱
Custom Applications
Build your own delivery-enabled application using the Deliverty API as the logistics backbone.
Next Step

Ready to get started? See Channel Setup to learn how an admin creates a channel and generates API credentials.