ConnectCloud Developers

List the tenant's comms webhook channels for step notifications (tenant:settings:read)

GET /api/workflow/v1/channels

Module: Workflow · operationId: listWebhookChannels · Tag: Blueprints · Auth: access token (Authorization: Bearer <accessToken>)

The channels a step can name as teamsChannel. URLs are never returned. Empty when comms is not configured.

Responses

  • 200 Channels (application/json)
  • 401 Missing or invalid token (unauthorized) (application/json)
  • 403 Error (application/json)
  • 503 Error (application/json)

Fields of the 200 answer:

  • items (array of WebhookChannel, required): Items of the list
    • format (string): Payload format of the channel (one of json_event, teams_card)
    • id (string): Channel id, used as a step's teamsChannel
    • name (string): Channel name
    • status (string): Status of the channel in comms
  • total (integer): Number of items

Example 200 answer:

{
  "items": [
    {
      "format": "teams_card",
      "id": "9c4e2b7a-1d3f-4a6b-8c5d-2e7f9a1b3c4d",
      "name": "Teams-Kanal Buchhaltung",
      "status": "active"
    }
  ],
  "total": 1
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/workflow/v1/channels' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI