testSlackAction()

🔒Security Requirements and Controls

CreateActions API permission

🎯API Stability

Long-TermThis API is stable and will remain supported across versions with minimal breaking changes.

Summary

The testSlackAction() mutation sends a test notification through a Slack action's configured webhook URL. Use it to confirm a Slack action delivers messages correctly. Run it before associating the action with an alert or scheduled search. Supply the view name, action name, webhook URL, message fields, and sample event data.

To create a Slack action, call createSlackAction(). To modify a Slack action, call updateSlackAction(). To remove an action, call deleteActionV2(). To test a Slack post message action instead, call testSlackPostMessageAction().

Hide Query Example

Show Slack Actions Query

To get a list of Slack actions, use the repository() query like so:

graphql

query {
     repository(name: "humio")
        { id, name,
          actions { id, name, 
                    ... on SlackAction { id, name } }
          }
   }

For more information on creating a Slack action, see Action Type: Slack. For related information, see Actions.

Syntax

graphql

testSlackAction(
      input: TestSlackAction!
   ): TestResult!

The mutation accepts a single required input argument of type TestSlackAction!. The input requires the view name, action name, webhook URL, message fields, proxy setting, trigger name, and event data. The mutation returns a non-null TestResult! object with a success indicator and a descriptive message.

Supply eventData as a JSON object or array of event objects. Supply triggerName as a mock value. The referenced trigger does not need to exist.

Input parameters

The input argument takes a TestSlackAction! object. All fields are required. Provide the view name and action name. Supply the webhook URL, message fields, proxy setting, a mock trigger name, and JSON event data.

Table: TestSlackAction Input Datatype

Parameter	Type	Required	Stability	Description
eventData	String	yes	`Long-Term`	JSON data representing one or more events. One event can be supplied as a JSON object. Multiple events must be supplied as a list of JSON objects.
fields	SlackFieldEntryInput	yes	`Long-Term`	The fields to include within the Slack message. Can be templated with values from the result. See SlackFieldEntryInput.
name	String	yes	`Long-Term`	The name of the action.
triggerName	String	yes	`Long-Term`	The name of the action. This is a mock value; the trigger doesn't have to exist.
url	String	yes	`Long-Term`	The Slack webhook URL where to send the request.
useProxy	Boolean	yes	`Long-Term`	Defines whether the action should use the configured proxy to make web requests.
viewName	String	yes	`Long-Term`	The name of the view of the action.

Example

Raw

graphql

mutation {
  testSlackAction( input: 
    { viewName: "humio",
      name: "act-up",
      url: "https://slack.company.com"
      fields: [ { fieldName: "msg", value: "hey!" } ]
      useProxy: false,
      triggerName: "ping",
      eventData: "[{\"#type\":\"kv\"}]",
      } )
  { success }
}

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 {
  testSlackAction( input: 
    { viewName: \"humio\",
      name: \"act-up\",
      url: \"https://slack.company.com\"
      fields: [ { fieldName: \"msg\", value: \"hey!\" } ]
      useProxy: false,
      triggerName: \"ping\",
      eventData: \"[{\\"#type\\":\\"kv\\"}]\",
      } )
  { success }
}"
}
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 {
  testSlackAction( input: 
    { viewName: \"humio\",
      name: \"act-up\",
      url: \"https://slack.company.com\"
      fields: [ { fieldName: \"msg\", value: \"hey!\" } ]
      useProxy: false,
      triggerName: \"ping\",
      eventData: \"[{\\"#type\\":\\"kv\\"}]\",
      } )
  { success }
}"
}
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 { ^
  testSlackAction( input:  ^
    { viewName: \"humio\", ^
      name: \"act-up\", ^
      url: \"https://slack.company.com\" ^
      fields: [ { fieldName: \"msg\", value: \"hey!\" } ] ^
      useProxy: false, ^
      triggerName: \"ping\", ^
      eventData: \"[{\\"#type\\":\\"kv\\"}]\", ^
      } ) ^
  { success } ^
}" ^
} '

Windows Powershell and curl

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  testSlackAction( input: 
    { viewName: \"humio\",
      name: \"act-up\",
      url: \"https://slack.company.com\"
      fields: [ { fieldName: \"msg\", value: \"hey!\" } ]
      useProxy: false,
      triggerName: \"ping\",
      eventData: \"[{\\"#type\\":\\"kv\\"}]\",
      } )
  { success }
}"
}'
    "$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 {
  testSlackAction( input: 
    { viewName: \"humio\",
      name: \"act-up\",
      url: \"https://slack.company.com\"
      fields: [ { fieldName: \"msg\", value: \"hey!\" } ]
      useProxy: false,
      triggerName: \"ping\",
      eventData: \"[{\\"#type\\":\\"kv\\"}]\",
      } )
  { success }
}";
$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 {
  testSlackAction( input: 
    { viewName: \"humio\",
      name: \"act-up\",
      url: \"https://slack.company.com\"
      fields: [ { fieldName: \"msg\", value: \"hey!\" } ]
      useProxy: false,
      triggerName: \"ping\",
      eventData: \"[{\\"#type\\":\\"kv\\"}]\",
      } )
  { success }
}"
}'''

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 {
  testSlackAction( input: 
    { viewName: \"humio\",
      name: \"act-up\",
      url: \"https://slack.company.com\"
      fields: [ { fieldName: \"msg\", value: \"hey!\" } ]
      useProxy: false,
      triggerName: \"ping\",
      eventData: \"[{\\"#type\\":\\"kv\\"}]\",
      } )
  { success }
}"
}
);


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": {
    "testSlackAction": {
      "success": false
    }
  }
}

Returned values

The mutation returns a non-null TestResult! object. It contains a boolean indicating whether the test succeeded and a message describing the outcome. Confirm the webhook URL is reachable and the Slack message renders as expected.

Table: TestResult Datatype

Parameter	Type	Required	Default	Stability	Availability	Description
message	String	yes		`Long-Term`		A message explaining the test result.
success	Boolean	yes		`Long-Term`		True if the test was a success, false otherwise.

Versions of this Page

GraphQL Mutations

GraphQL API

GraphQL Queries

GraphQL Datatypes