package executor

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Execute (ExecuteRequest, ExecuteResponse)

  executor.proto:124

  message ExecuteRequest

  executor.proto:17

  • string command = 1

    command represents the exact command that was specified by the user.

  • repeated Config configs = 2

    configs is a list of Executor configurations specified by users.

  • optional ExecuteContext context = 3

    context holds context execution.

  message ExecuteResponse

  executor.proto:70

  • bytes message = 1

    message represents the output of processing a given input command. You can construct a complex message or just use one of our helper functions: - api.NewCodeBlockMessage("body", true) - api.NewPlaintextMessage("body", true)

  • repeated bytes messages = 2

    messages holds a collection of messages that should be dispatched to the user in the context of a given command execution. To avoid spamming, you can specify max 15 messages. Limitations: - It's available only for SocketSlack. In the future, it may be adopted across other platforms. - Interactive message filtering is not available. (https://docs.botkube.io/usage/interactive-output-filtering)

• rpc Metadata (google.protobuf.Empty, MetadataResponse)

  executor.proto:125

  message MetadataResponse

  executor.proto:85

  MetadataResponse represents metadata of a given plugin. Data is used to generate a plugin index file.

  • string version = 1

    version is a version of a given plugin. It should follow the SemVer syntax.

  • string description = 2

    description is a description of a given plugin.

  • optional JSONSchema json_schema = 3

    json_schema is a JSON schema of a given plugin.

  • map<string, Dependency> dependencies = 4

    dependencies is a list of dependencies of a given plugin.

  • string documentation_url = 5

    URL to plugin documentation.

  • bool recommended = 6

    Recommended plugin recommended

• rpc Help (google.protobuf.Empty, HelpResponse)

  executor.proto:126

  message HelpResponse

  executor.proto:115

  HelpResponse represents help of a given plugin.

  • bytes help = 1

    help is the help of a given plugin. You can construct a complex message with buttons etc, or just use one of our helper functions: - api.NewCodeBlockMessage("body", true) - api.NewPlaintextMessage("body", true)

Config holds the Executor configuration.

Used in: ExecuteRequest

• bytes rawYAML = 1

  rawYAML contains the Executor configuration in YAML definitions. Configuration data is unique per executor. Botkube related configuration details are stored in ExecuteContext instead.

Dependency represents a dependency of a given plugin. All binaries are downloaded before the plugin is started.

Used in: MetadataResponse

• map<string, string> urls = 1

  urls is the map of URL of the dependency. The key is in format of "os/arch", such as "linux/amd64".

Used in: ExecuteRequest

• bool isInteractivitySupported = 1

  isInteractivitySupported is set to true only if communication platform supports interactive Messages with buttons, select menus, etc. If set to false, you should send only text based messages.

• bytes slackState = 2

  slackState represents modal state. It's available only if: - IsInteractivitySupported is set to true, - and interactive actions were used in the response Message. This is an alpha feature and may change in the future. Most likely, it will be generalized to support all communication platforms.

• bytes kubeConfig = 3

  kubeConfig is the slice of byte representation of kubeconfig file content. it is available only if context.rbac is configured for a given plugins. Otherwise, it is empty.

• optional MessageContext message = 4

  message holds message details that triggered a given Executor.

• optional IncomingWebhookContext incomingWebhook = 5

  incomingWebhook holds details about Botkube built-in incoming webhook configuration.

IncomingWebhookContext holds information about the built-in incoming webhook that allows triggering HandleExternalRequest on a given source.

Used in: ExecuteContext

• string baseSourceURL = 1

JSONSchema represents a JSON schema of a given plugin configuration.

Used in: MetadataResponse

• string value = 1

  value is the string value of the JSON schema.

• string ref_url = 2

  ref_url is the remote reference of the JSON schema.

Used in: ExecuteContext

• string text = 1

  text is the text of the message in the raw format.

• string url = 2

  url is the URL of the message. Can be used to open the message in a browser.

• string parentActivityId = 3

  parentActivityId is the ID of the parent activity. If user follows with messages in a thread, this ID represents the originating message that started that thread. Otherwise, it's the ID of the initial message.

• optional UserContext user = 4

  user holds user details that wrote a given message.

Used in: MessageContext

• string mention = 1

  mention represents a user platforms specific mention of the user.

• string displayName = 2

  displayName represents user display name. It can be empty.