⚙️ Channel Setup
How to create and configure a channel in Deliverty Hub.
Prerequisites
Before a channel can be created, the following must be in place:
- An organization exists in Deliverty Hub.
- The person creating the channel has Admin or Organization Admin role privileges.
- A user account is available (or will be created) to associate with the channel for API authentication.
Creating a Channel
Organization administrators create channels through the Deliverty Hub dashboard. The process involves defining the channel's identity, associating it with a user, and generating API credentials.
Navigate to Channels
In the dashboard sidebar, go to Channels under your organization settings.
Click "Create Channel"
Open the channel creation form and fill in the required fields.
Configure the channel
Provide a name, optional description, and select the user account that will be associated with this channel.
Generate API credentials
After creation, generate an API key. Store this key securely — it will only be shown once.
Channel Entity Fields
The channel entity contains the following fields:
| Field | Type | Constraints | Description |
|---|---|---|---|
name |
string |
Required, max 255 characters | Human-readable name for the channel (e.g., "My Shopify Store") |
description |
string |
Optional, max 1000 characters | A longer description of the channel's purpose or the system it represents |
status |
enum |
Required | One of: ACTIVE, INACTIVE, SUSPENDED |
userId |
number |
Required | The user account tied to this channel. Used for API key authentication and audit trails. |
organizationId |
number |
Required (auto-set) | The organization this channel belongs to. Automatically set based on the admin's organization context. |
Managing Channel Status
After creation, administrators can change a channel's status at any time from the dashboard:
- Activate — Set the channel to ACTIVE to allow API requests.
- Deactivate — Set the channel to INACTIVE to temporarily block all API requests. No data is lost; tasks already created remain unaffected.
- Suspend — Set the channel to SUSPENDED to block API access due to policy or billing issues. Only an admin can lift a suspension.
The API key is shown only once when generated. If lost, the admin must regenerate a new key, which invalidates the previous one. Store the key in a secure location such as an environment variable or a secrets manager.
Best Practices
- One channel per integration — Create separate channels for each external system (e.g., one for your Shopify store, another for your internal OMS). This provides clear audit trails and the ability to disable individual integrations.
- Descriptive names — Use clear, identifiable names like "Production - Shopify" or "Staging - Custom App" so administrators can quickly identify each channel.
- Dedicated user accounts — Associate each channel with a dedicated service user rather than a personal admin account. This prevents disruption if an employee leaves.
- Rotate keys periodically — Regenerate API keys on a regular schedule as a security best practice.
Once your channel is created, learn how to authenticate API requests in Authentication.