API Stability Long-Term

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!

Below is an example of how this mutation field might be used:

Raw
graphql
mutation {
  createSlackPostMessageAction( input:
     { viewName: "humio",
       name: "my-slack-post-act",
       apiToken: "AUamuZLYvOLGUeMablONDF37FbYIm7U",
       channels: ["#admin"]
       fields: [ {fieldName: "Events String", value: "{events_str}"} ],
       useProxy: false
    } )
  { id }
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  createSlackPostMessageAction( input:
     { viewName: \"humio\",
       name: \"my-slack-post-act\",
       apiToken: \"AUamuZLYvOLGUeMablONDF37FbYIm7U\",
       channels: [\"#admin\"]
       fields: [ {fieldName: \"Events String\", value: \"{events_str}\"} ],
       useProxy: false
    } )
  { id }
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  createSlackPostMessageAction( input:
     { viewName: \"humio\",
       name: \"my-slack-post-act\",
       apiToken: \"AUamuZLYvOLGUeMablONDF37FbYIm7U\",
       channels: [\"#admin\"]
       fields: [ {fieldName: \"Events String\", value: \"{events_str}\"} ],
       useProxy: false
    } )
  { id }
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  createSlackPostMessageAction( input: ^
     { viewName: \"humio\", ^
       name: \"my-slack-post-act\", ^
       apiToken: \"AUamuZLYvOLGUeMablONDF37FbYIm7U\", ^
       channels: [\"#admin\"] ^
       fields: [ {fieldName: \"Events String\", value: \"{events_str}\"} ], ^
       useProxy: false ^
    } ) ^
  { id } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  createSlackPostMessageAction( input:
     { viewName: \"humio\",
       name: \"my-slack-post-act\",
       apiToken: \"AUamuZLYvOLGUeMablONDF37FbYIm7U\",
       channels: [\"#admin\"]
       fields: [ {fieldName: \"Events String\", value: \"{events_str}\"} ],
       useProxy: false
    } )
  { id }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  createSlackPostMessageAction( input:
     { viewName: \"humio\",
       name: \"my-slack-post-act\",
       apiToken: \"AUamuZLYvOLGUeMablONDF37FbYIm7U\",
       channels: [\"#admin\"]
       fields: [ {fieldName: \"Events String\", value: \"{events_str}\"} ],
       useProxy: false
    } )
  { id }
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  createSlackPostMessageAction( input:
     { viewName: \"humio\",
       name: \"my-slack-post-act\",
       apiToken: \"AUamuZLYvOLGUeMablONDF37FbYIm7U\",
       channels: [\"#admin\"]
       fields: [ {fieldName: \"Events String\", value: \"{events_str}\"} ],
       useProxy: false
    } )
  { id }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  createSlackPostMessageAction( input:
     { viewName: \"humio\",
       name: \"my-slack-post-act\",
       apiToken: \"AUamuZLYvOLGUeMablONDF37FbYIm7U\",
       channels: [\"#admin\"]
       fields: [ {fieldName: \"Events String\", value: \"{events_str}\"} ],
       useProxy: false
    } )
  { id }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  path: 'graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "createSlackPostMessageAction": {
      "id": "z6HrAfznuPHFOKVSVg4J9a4qsg9oIsoq"
    }
  }
}

Given Datatypes

For CreatePostMessageSlackAction, there are a few parameters. Below is a list of them along with descriptions of each:

Table: CreatePostMessageSlackAction

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 17, 2024
apiTokenstringyes Long-TermAPI token to authenticate with Slack.
channels[string]yes Long-TermList of Slack channels to message.
fields[SlackFieldEntryInput]yes Long-TermFields to include within the Slack message. Can be templated with values from the result. See SlackFieldEntryInput.
namestringyes Long-TermName of the action.
useProxybooleanyes Long-TermDefines whether the action should use the configured proxy to make web requests.
viewNamestringyes Long-TermName of the view of the action.

Returned Datatypes

SlackPostMessageAction has several parameters. Below is a list of them:

Table: SlackPostMessageAction

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 30, 2025
allowedActions[AssetAction]yes Short-TermA list of allowed asset actions. See AssetAction .
apiTokenstringyes Long-TermAn API token to authenticate with Slack.
channels[string]yes Long-TermA list of Slack channels to message.
createdInfoAssetCommitMetadata  Long-TermMetadata related to the creation of the action. See AssetCommitMetadata.
displayNamestringyes Long-TermThe display name of the action.
fields[SlackFieldEntry]yes Long-TermThe fields to include within the Slack message. Can be templated with values from the result See SlackFieldEntry.
idstringyes Long-TermThe unique identifier of the action.
isAllowedToRunbooleanyes Long-TermFalse if this type of action is disabled because of a security policy, true otherwise.
labels[string]yes PreviewThe labels associated with the action.
modifiedInfoAssetCommitMetadata  Long-TermMetadata related to the latest modification of the action. See AssetCommitMetadata.
namestringyes Long-TermThe name of the action.
packagePackageInstallation  Long-TermThe package, if any, of which the action is part (see PackageInstallation Table).
packageIdVersionedPackageSpecifier  Long-TermThe unique identifier of the package. VersionedPackageSpecifier is a scalar.
requiresOrganizationOwnedQueriesPermissionToEditbooleanyes Long-TermTrue 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.
resourcestringyes Short-TermThe resource identifier for the action.
useProxybooleanyes Long-TermWhether the action should use the configured proxy to make web requests.
yamlTemplateYAMLyes Long-TermA template that can be used to recreate the action. YAML is a scalar.