Skip to main content
Connect Service Channel to KODE OS for work orders data integration

Overview

Use this integration to connect Service Channel to KODE OS. You can discover assets as devices, sync work orders on a snapshot poll, and create work orders from KODE OS workflows and automations.

Supported Capabilities

  • Discover Devices & Points
  • Collect Non-Sensor Data
  • Collect Historical Data
  • Collect Historical Multi-Entity Data
  • Create Work Orders

Prerequisites

  • A Service Channel account with API access
  • OAuth client credentials (Client ID and Client Secret) from Service Channel
  • Username, password, and user type (Provider or Subscriber)
  • Store ID for the site (and Subscriber ID when the user type is Provider)
  • KODE OS environment with access to Data Sources
Typical Service Channel hosts:

Generate API Credentials

  1. Log in to the Service Channel developer portal or admin console
  2. Navigate to the API or developer settings section
  3. Create a new API application or client
  4. Note the Client ID, Client Secret, and Auth URL for OAuth token exchange

Configure Connector in KODE OS

  1. Navigate to Data Sources in your building
  2. Click API Catalog and search for Service Channel
  3. Click + Add Datasource
  4. Fill in the fields below and validate credentials. Then select the store and subscriber, or type those IDs if the lists do not load.

Discover Devices and Points

After configuring the connector, click Discover on the connector detail page. KODE OS will query Service Channel and return available devices and points. Review the discovered items and select the devices you want to register in KODE OS. For more details on the discovery process, see the Discovery guide.

Devices and Points

When you discover devices from Service Channel, KODE OS maps them to the following device types and data points:

Connected Device

Canonical Type: default

What Data You Get

Point History

Time-series connection_status readings from discovered devices.

Work Orders

Maintenance and service requests including title, description, status, priority, assignee, due dates, vendor response, resolution details, and cost estimates. KODE OS maps Service Channel data to these standard fields:

Polling Schedule

  • Point History — Default polling: 15 minutes (min: 15 minutes, max: 1 hours)
  • WorkOrder — Default polling: 15 minutes (min: 15 minutes, max: 1 days)
For more details on collection modes, see the Data Collection guide.

Available Actions

Create Service Channel Work Order

Type: Write Creates a new work order in Service Channel. On create, KODE OS sends description as area / problemType / equipment / problemCode / description. Call date is set to the current date. Store ID comes from the linked device when you provide a device or point, otherwise from the connector.

Linked versus unlinked create

  • Linked to a device: Provide a device_id or point_id. Store, subscriber, and provider come from that device. Trade uses the value on the form (defaulted from the device when KODE OS can match it).
  • Not linked to a device: Do not send device_id or point_id. Store comes from the connector. Subscriber comes from the connector when set. Provider is not set. Trade must be filled in on the form.

Example Request

Expected Result

  • KODE OS sends the action to Service Channel using the configured connector credentials
  • Service Channel returns success and creates the work order
For more details on how actions work, see the Actions guide.

Use Cases

Once connected, this integration enables you to:
  • Centralize maintenance requests and work order status from Service Channel
  • Create work orders from KODE OS with category, priority, trade, and cascaded issue-list fields
  • Track maintenance KPIs including response time, completion rate, and cost

Troubleshooting

Verify URL, Auth URL, username, password, Client ID, and Client Secret. Confirm User Type matches the account. If the user type is Provider, Subscriber ID is required.
Validate credentials first so KODE OS can load store and subscriber options from Service Channel. If the list still does not load, type the Store ID and, for a Provider user, the Subscriber ID.
Verify the connector credentials can list assets for the selected store. Run a test connection, then discover again.
Trade Name is always required. Category, Priority, Description, and NTE are required. If you use Area, Problem Type, Equipment, and Problem Code, fill them in order. For an unlinked create, do not send a device or point id.
Check the connector status on the Data Sources page. If the status shows an error, review the error logs on the connector detail page. Common causes include expired credentials, network changes, or rate limiting by the Service Channel API.
Last modified on November 2, 2026