ZRM Docs
Domain Model

Channel Endpoint

Fields

FieldTypeRequiredDefaultDescription
idstring.uuidYesId
createdAtstring.date-timeYesCreated at
updatedAtstring.date-timeYesUpdated at
providerenum(telegram, whatsapp, discord, slack, microsoft_teams, ai_agent, email)YesProvider
endpointTypeenum(bot, channel, phone_number, guild_app, dm, group_chat, workspace_app, thread)YesEndpoint type
externalEndpointIdstringYesID of the associated external endpoint
displayNamestringYesDisplay name
workspaceIdstringYesID of the associated workspace
connectionIdstringNoID of the associated connection
configJsonobjectNoConfig json
statusstringYesStatus
agentAutonomyLevelenum(draft_only, auto_low_risk, auto_all)YesAgent autonomy level
visibilityModeenum(global, workspace_local, shared)YesVisibility mode

Create Schema

Fields accepted when creating a new record:

FieldTypeRequiredDefaultDescription
providerenum(telegram, whatsapp, discord, slack, microsoft_teams, ai_agent, email)YesProvider
endpointTypeenum(bot, channel, phone_number, guild_app, dm, group_chat, workspace_app, thread)YesEndpoint type
externalEndpointIdstringYesID of the associated external endpoint
displayNamestringYesDisplay name
workspaceIdstringYesID of the associated workspace
connectionIdstringNoID of the associated connection
configJsonobjectNoConfig json
statusstringYes"active"Status
agentAutonomyLevelenum(draft_only, auto_low_risk, auto_all)Yes"draft_only"Agent autonomy level
visibilityModeenum(global, workspace_local, shared)Yes"workspace_local"Visibility mode

Update Schema

All fields are optional when updating:

FieldTypeRequiredDefaultDescription
endpointTypeenum(bot, channel, phone_number, guild_app, dm, group_chat, workspace_app, thread)NoEndpoint type
externalEndpointIdstringNoID of the associated external endpoint
displayNamestringNoDisplay name
connectionIdstringNoID of the associated connection
configJsonobjectNoConfig json
statusstringNo"active"Status
agentAutonomyLevelenum(draft_only, auto_low_risk, auto_all)No"draft_only"Agent autonomy level

On this page