ZRM Docs
Domain Model

Bot Command

Fields

FieldTypeRequiredDefaultDescription
idstring.uuidYesId
createdAtstring.date-timeYesCreated at
updatedAtstring.date-timeYesUpdated at
providerenum(telegram, whatsapp, discord, slack, microsoft_teams, ai_agent, email)YesProvider
commandNamestringYesCommand name
commandSchemaJsonobjectNoCommand schema json
handlerNamestringYesHandler name
workspaceIdstringYesID of the associated workspace
channelEndpointIdstringNoID of the associated channel endpoint
enabledbooleanYesEnabled
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
commandNamestringYesCommand name
commandSchemaJsonobjectNoCommand schema json
handlerNamestringYesHandler name
workspaceIdstringYesID of the associated workspace
channelEndpointIdstringNoID of the associated channel endpoint
enabledbooleanYestrueEnabled
visibilityModeenum(global, workspace_local, shared)Yes"workspace_local"Visibility mode

Update Schema

All fields are optional when updating:

FieldTypeRequiredDefaultDescription
commandNamestringNoCommand name
commandSchemaJsonobjectNoCommand schema json
handlerNamestringNoHandler name
channelEndpointIdstringNoID of the associated channel endpoint
enabledbooleanNotrueEnabled

On this page