ConnectCloud Developers

Create a channel (comms:admin)

POST /api/comms/v1/channels

Module: Comms · operationId: createChannel · Tag: Channels · Auth: access token (Authorization: Bearer <accessToken>)

The first e-mail channel becomes the tenant's default. At most 20 channels per tenant. Channels of kind teams are created by comms when the Teams app is added to a team or group chat (disabled until an administrator enables them); this route refuses the kind (400).

Request body

application/json (required)

  • config (object): The kind's configuration fields (FieldSpec keys that are not secret)
  • kind (string): Only on create
  • name (string): Display name (max length 80)
  • rev (integer): Optimistic lock (0 skips the check)
  • secrets (object): The kind's secret fields; empty or ******** keeps the stored value
  • status (string): active or disabled (one of active, disabled)

Example:

{
  "config": {
    "format": "teams_card"
  },
  "kind": "webhook",
  "name": "Teams-Kanal Service Desk",
  "rev": 0,
  "secrets": {
    "url": "https://muster-it.webhook.office.example/workflows/servicedesk"
  },
  "status": "active"
}

Responses

  • 201 Created (application/json)
  • 400 Error (application/json)

Fields of the 201 answer:

  • config (object): The kind's public configuration. Kind teams (read-only): teamName, channelName and conversationType (channel or groupChat); the conversation's Teams ids stay in comms.
  • createdAt (string (date-time)): Creation time
  • createdBy (string): Who created the channel
  • id (string (uuid)): Channel id
  • isDefault (boolean): The tenant's default e-mail channel
  • kind (string): Channel kind (see ChannelKind.kind)
  • lastCheckAt (string (date-time)): Time of the last connection test
  • lastCheckOk (boolean): Result of the last connection test
  • lastError (string): Error of the last connection test
  • medium (string): push is the platform channel that fans out to the devices of a person (ADR 0043); no caller routes to it (one of email, webhook, teams, push)
  • name (string): Display name
  • rev (integer): Revision for optimistic locking (send it back as rev)
  • secrets (object): Which secret fields are set; values are never returned
  • status (string): active channels send; disabled ones do not (one of active, disabled)
  • updatedAt (string (date-time)): Time of the last change

Example 201 answer:

{
  "config": {
    "format": "teams_card"
  },
  "createdAt": "2026-09-03T14:05:11Z",
  "createdBy": "sophie.huber@muster-it.example",
  "id": "9c4e2b7a-1d3f-4a6b-8c5d-2e7f9a1b3c4d",
  "isDefault": false,
  "kind": "webhook",
  "lastCheckAt": "2026-11-16T08:12:40Z",
  "lastCheckOk": true,
  "medium": "webhook",
  "name": "Teams-Kanal Service Desk",
  "rev": 2,
  "secrets": {
    "signingSecret": true,
    "url": true
  },
  "status": "active",
  "updatedAt": "2026-11-16T08:12:40Z"
}

Example request

curl -X POST 'https://api.mbcom.cloud/api/comms/v1/channels' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"config":{"format":"teams_card"},"kind":"webhook","name":"Teams-Kanal Service Desk","rev":0,"secrets":{"url":"https://muster-it.webhook.office.example/workflows/servicedesk"},"status":"active"}'

View as Markdown · Interactive reference · OpenAPI