ZRM Docs
API ReferenceBot Command

botCommand.register

Type: Mutation · Auth: Workspace-aware

Input

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

Example

{
  "provider": "telegram",
  "commandName": "example",
  "commandSchemaJson": null,
  "handlerName": "example",
  "workspaceId": "550e8400-e29b-41d4-a716-446655440000",
  "channelEndpointId": "550e8400-e29b-41d4-a716-446655440000",
  "enabled": true,
  "visibilityMode": "global"
}

On this page