Channel kinds and settings for the settings pages (comms:read)
GET /api/comms/v1/bootstrap
Module: Comms · operationId: getBootstrap · Tag: Settings · Auth: access token (Authorization: Bearer <accessToken>)
Responses
- 200 Bootstrap (
application/json) - 403 Error (
application/json)
Fields of the 200 answer:
canAdmin(boolean): Whether the caller may change channels and settings (comms:admin)channelKinds(array of ChannelKind): The channel kinds a tenant can configure, with their form fieldscapabilities(object): Optional abilities of the kindhtml(boolean): The kind can send HTMLinbound(boolean): The kind can also receive (a mailbox)
description(string): Short explanation of the kindfields(array of FieldSpec): Configuration and secret fields of the kindhelp(string): Help text for the fieldkey(string): Key inconfigorsecretslabel(string): Display label of the fieldoptions(array of object): Choices of a select fieldlabel(string): Display labelvalue(string): Stored value
required(boolean): The field must be setsecret(boolean): Stored encrypted and never returnedtype(string): Input type; secret fields go intosecretsand are never returned (one oftext,email,url,secret,select,number,bool)
kind(string): Kind key, used askindwhen creating a channellabel(string): Display name of the kindmanaged(boolean): Created by comms itself (kindteams: when the Teams app is added to a team or group chat), never through POST /channels; the configuration is read-onlymedium(string): push is the platform channel that fans out to the devices of a person (ADR 0043); no caller routes to it (one ofemail,webhook,teams,push)owner(string): platform: run by the platform; tenant: configured by the tenant (one ofplatform,tenant)
events(array of EventSpec): The event catalogue personal subscriptions can start ondefault(object): Default subject and body of a notification of the eventbody(string): Body templatesubject(string): Subject template
fields(array of EventField): Payload fields conditions and templates may usekind(string): Value type of the field (one oftext,number,date,bool,list)label(string): Display name of the fieldpath(string): Path of the field in the event payload
group(string): Group the event is listed underlabel(string): Display name of the eventlink(string): Portal path of the event's record with {path} placeholderspeople(array of object): Payload fields that name people (recipients of the event)kind(string): How the field names the person (one ofemail,employee,user_ref,user_refs)label(string): Display name of the rolemanager(boolean): The person's managers can be addressed toopath(string): Path of the field in the event payload
source(string): Producing moduletype(string): Event type, e.g. hr.absence.requested
settings(Settings)defaultEmailChannelId(string (uuid)): The tenant's default e-mail channel; empty: the platform channelrev(integer): Revision of the settings
Example 200 answer:
{
"canAdmin": true,
"channelKinds": [
{
"capabilities": {
"html": false,
"inbound": false
},
"description": "Signierte HTTP-Anfragen an eine Adresse Ihrer Wahl, z. B. einen Teams-Workflow oder Power Automate.",
"fields": [
{
"help": "Wird verschlüsselt gespeichert, weil Webhook-Adressen oft ein Zugriffstoken enthalten.",
"key": "url",
"label": "Adresse (URL)",
"required": true,
"secret": true,
"type": "url"
},
{
"key": "format",
"label": "Format",
"options": [
{
"label": "JSON-Ereignis",
"value": "json_event"
},
{
"label": "Microsoft Teams (Adaptive Card)",
"value": "teams_card"
}
],
"required": true,
"secret": false,
"type": "select"
}
],
"kind": "webhook",
"label": "Webhook",
"managed": false,
"medium": "webhook",
"owner": "tenant"
}
],
"events": [
{
"default": {
"body": "Die Abwesenheit „{{typeName}}“ von {{employeeName}} vom {{startDate}} bis {{endDate}} ({{days}} Arbeitstage) wurde beantragt.\n\n{{link}}",
"subject": "Abwesenheit beantragt: {{employeeName}} ({{startDate}} – {{endDate}})"
},
"fields": [
{
"kind": "text",
"label": "Mitarbeiter:in",
"path": "employeeName"
},
{
"kind": "date",
"label": "Von",
"path": "startDate"
},
{
"kind": "date",
"label": "Bis",
"path": "endDate"
},
{
"kind": "number",
"label": "Arbeitstage",
"path": "days"
}
],
"group": "Personal",
"label": "Abwesenheit beantragt",
"link": "/hr/absences/{absenceId}",
"people": [
{
"kind": "employee",
"label": "Antragsteller:in",
"manager": true,
"path": "employeeId"
}
],
"source": "hr",
"type": "hr.absence.requested"
}
],
"settings": {
"defaultEmailChannelId": "6b1f3c2a-8d4e-4f5a-9b7c-1e2d3f4a5b6c",
"rev": 3
}
}
Example request
curl -X GET 'https://api.mbcom.cloud/api/comms/v1/bootstrap' \
-H "Authorization: Bearer $ACCESS_TOKEN"