The createSlackPostMessageAction() GraphQL mutation field may be used to create a post message, Slack action in LogScale.

For more information on creating a Slack action, see the Action Type: Slack documentation page. You may also want to look at the Actions page for related information.

Syntax

Below is the syntax for the createSlackPostMessageAction() mutation field:

graphql
createSlackPostMessageAction(
      input: CreatePostMessageSlackAction!
   ): SlackPostMessageAction!

Given Datatypes

For the given datatype, CreatePostMessageSlackAction, there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: CreatePostMessageSlackAction

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 17, 2024
apiTokenstringyes API token to authenticate with Slack.
channels[string]yes List of Slack channels to message.
fields[SlackFieldEntryInput]yes Fields to include within the Slack message. Can be templated with values from the result. See SlackFieldEntryInput.
namestringyes Name of the action.
useProxybooleanyes Defines whether the action should use the configured proxy to make web requests.
viewNamestringyes Name of the view of the action.

Returned Datatypes

The returned datatype SlackPostMessageAction has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: SlackPostMessageAction

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
allowedActions[AssetAction]yes A list of allowed asset actions. See AssetAction. This is a preview and subject to change.
apiTokenstringyes An API token to authenticate with Slack.
channels[string]yes A list of Slack channels to message.
displayNamestringyes The display name of the action.
fields[SlackFieldEntry]yes The fields to include within the Slack message. Can be templated with values from the result See SlackFieldEntry.
idstringyes The unique identifier of the action.
isAllowedToRunbooleanyes False if this type of action is disabled because of a security policy, true otherwise.
namestringyes The name of the action.
packagePackageInstallationyes The package, if any, of which the action is part (see PackageInstallation Table).
packageIdVersionedPackageSpecifieryes The unique identifier of the package. VersionedPackageSpecifier is a scalar.
requiresOrganizationOwnedQueriesPermissionToEditbooleanyes True if this action is used by triggers, where the query is run by the organization. If true, then the OrganizationOwnedQueries permission is required to edit the action.
useProxybooleanyes Whether the action should use the configured proxy to make web requests.
yamlTemplateyamlyes A template that can be used to recreate the action.