The createSlackAction() GraphQL mutation may be used to create a 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 createSlackAction() mutation field:

graphql
createSlackAction(
      input: CreateSlackAction!
   ): SlackAction!

Given Datatypes

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

Table: CreateSlackAction

ParameterTypeRequired[a]DefaultDescription
viewNamestringyes Name of the view of the action.
namestringyes Name of the action.
urlstringyes Slack webhook URL to where request is to be sent.
fieldsSlackFieldEntryInputyes Fields to include within the Slack message. Can be templated with values from the result (see SlackFieldEntryInput Table).
useProxybooleanyes Defines whether the action should use the configured proxy to make web requests.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.


Returned Datatypes

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

Table: SlackAction

ParameterTypeRequired[a]DefaultDescription
urlstringyes The Slack webhook URL where to send the requests.
fields[SlackFieldEntry]yes The fields to include within the Slack message. This can be templated with values from the result (see SlackFieldEntry Table).
useProxybooleanyes Whether the action should use the configured proxy to make web requests.
namestringyes The name of the action.
displayNamestringyes The display name of the action.
idstringyes The unique identifier of the action.
yamlTemplateYAMLyes A template that can be used to recreate the action.
packagePackageInstallation  The package, if there is one, of which the action is part (see PackageInstallation Table).

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.