API Stability Long-Term

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!

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

Raw
graphql
mutation {
  createSlackAction( input:
     { viewName: "humio",
       name: "my-slack-act",
       url: "https://slack.com/api/chat.postMessage",
      fields: [ {fieldName: "Events String", value: "{events_str}"},
                {fieldName: "Time Interval", value: "{query_time_interval}"} ],
      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 {
  createSlackAction( input:
     { viewName: \"humio\",
       name: \"my-slack-act\",
       url: \"https://slack.com/api/chat.postMessage\",
      fields: [ {fieldName: \"Events String\", value: \"{events_str}\"},
                {fieldName: \"Time Interval\", value: \"{query_time_interval}\"} ],
      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 {
  createSlackAction( input:
     { viewName: \"humio\",
       name: \"my-slack-act\",
       url: \"https://slack.com/api/chat.postMessage\",
      fields: [ {fieldName: \"Events String\", value: \"{events_str}\"},
                {fieldName: \"Time Interval\", value: \"{query_time_interval}\"} ],
      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 { ^
  createSlackAction( input: ^
     { viewName: \"humio\", ^
       name: \"my-slack-act\", ^
       url: \"https://slack.com/api/chat.postMessage\", ^
      fields: [ {fieldName: \"Events String\", value: \"{events_str}\"}, ^
                {fieldName: \"Time Interval\", value: \"{query_time_interval}\"} ], ^
      useProxy: false ^
    } ) ^
  { id } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  createSlackAction( input:
     { viewName: \"humio\",
       name: \"my-slack-act\",
       url: \"https://slack.com/api/chat.postMessage\",
      fields: [ {fieldName: \"Events String\", value: \"{events_str}\"},
                {fieldName: \"Time Interval\", value: \"{query_time_interval}\"} ],
      useProxy: false
    } )
  { id }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  createSlackAction( input:
     { viewName: \"humio\",
       name: \"my-slack-act\",
       url: \"https://slack.com/api/chat.postMessage\",
      fields: [ {fieldName: \"Events String\", value: \"{events_str}\"},
                {fieldName: \"Time Interval\", value: \"{query_time_interval}\"} ],
      useProxy: false
    } )
  { id }
}"
}';
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 {
  createSlackAction( input:
     { viewName: \"humio\",
       name: \"my-slack-act\",
       url: \"https://slack.com/api/chat.postMessage\",
      fields: [ {fieldName: \"Events String\", value: \"{events_str}\"},
                {fieldName: \"Time Interval\", value: \"{query_time_interval}\"} ],
      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 {
  createSlackAction( input:
     { viewName: \"humio\",
       name: \"my-slack-act\",
       url: \"https://slack.com/api/chat.postMessage\",
      fields: [ {fieldName: \"Events String\", value: \"{events_str}\"},
                {fieldName: \"Time Interval\", value: \"{query_time_interval}\"} ],
      useProxy: false
    } )
  { id }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  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": {
    "createSlackAction": {
      "id": "ADlkXn3UtMbMfC8T0ACezL1Qd56K7rRk"
    }
  }
}

Given Datatypes

For createSlackAction(), there are a few parameters that may be given. Below is a list of them along with a description of each:

Table: CreateSlackAction

ParameterTypeRequiredDefaultStabilityDescription
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
fieldsSlackFieldEntryInputyes Long-TermFields to include within the Slack message. Can be templated with values from the result. See SlackFieldEntryInput.
namestringyes Long-TermName of the action.
urlstringyes Long-TermSlack webhook URL to where request is to be sent.
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

The returned datatype SlackAction has several parameters. Below is a list of them:

Table: SlackAction

ParameterTypeRequiredDefaultStabilityDescription
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: Mar 27, 2025
allowedActions[AssetAction]yes PreviewA list of allowed asset actions. See AssetAction. This is a preview and subject to change.
displayNamestringyes Long-TermThe display name of the action.
fields[SlackFieldEntry]yes Long-TermThe fields to include within the Slack message. This 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.
namestringyes Long-TermThe name of the action.
packagePackageInstallation  Long-TermThe package, if there is one, of which the action is part (see PackageInstallation Table).
packageIdVersionedPackageSpecifieryes 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.
urlstringyes Long-TermThe Slack webhook URL where to send the requests.
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.