API Stability Long-Term

The testEmailAction() GraphQL mutation is used to test an email action.

Syntax

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

graphql
testEmailAction(
      input: TestEmailAction!
   ): TestResult!

For the input, you'll have to provide several parameters and values for the action you want to test. See the Given Datatypes section below for more details.

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

Raw
graphql
mutation {
  testEmailAction( input: 
    { viewName: "humio",
      name: "email-admin",
      recipients: [ "bob@company.com" ],
      useProxy: false,
      triggerName: "fire",
      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 {
  testEmailAction( input: 
    { viewName: \"humio\",
      name: \"email-admin\",
      recipients: [ \"bob@company.com\" ],
      useProxy: false,
      triggerName: \"fire\",
      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 {
  testEmailAction( input: 
    { viewName: \"humio\",
      name: \"email-admin\",
      recipients: [ \"bob@company.com\" ],
      useProxy: false,
      triggerName: \"fire\",
      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 { ^
  testEmailAction( input:  ^
    { viewName: \"humio\", ^
      name: \"email-admin\", ^
      recipients: [ \"bob@company.com\" ], ^
      useProxy: false, ^
      triggerName: \"fire\", ^
      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 {
  testEmailAction( input: 
    { viewName: \"humio\",
      name: \"email-admin\",
      recipients: [ \"bob@company.com\" ],
      useProxy: false,
      triggerName: \"fire\",
      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 {
  testEmailAction( input: 
    { viewName: \"humio\",
      name: \"email-admin\",
      recipients: [ \"bob@company.com\" ],
      useProxy: false,
      triggerName: \"fire\",
      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 {
  testEmailAction( input: 
    { viewName: \"humio\",
      name: \"email-admin\",
      recipients: [ \"bob@company.com\" ],
      useProxy: false,
      triggerName: \"fire\",
      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 {
  testEmailAction( input: 
    { viewName: \"humio\",
      name: \"email-admin\",
      recipients: [ \"bob@company.com\" ],
      useProxy: false,
      triggerName: \"fire\",
      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": {
    "testEmailAction": {
      "success": true
    }
  }
}

Given Datatypes

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

Table: TestEmailAction

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: Mar 28, 2025
attachCsvboolean falseLong-TermWhether the result set should be be attached as a CSV file.
bodyTemplatestring  Long-TermThe body of the email. Can be templated with values from the result.
eventDatastringyes Long-TermJSON 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.
namestringyes Long-TermThe name of the action.
recipients[string]yes Long-TermA list of email addresses where to send an email.
subjectTemplatestring  Long-TermThe subject of the email. Can be templated with values from the result.
triggerNamestringyes Long-TermThe name of the action. This is a mock value. The trigger doesn't have to exist.
useProxybooleanyes Long-TermDefines whether the action should use the configured proxy to make web requests.
viewNamestringyes Long-TermThe name of the view of the action.

Returned Datatypes

The returned datatype, TestResult has two parameters. They're listed in the table below with descriptions of each:

Table: TestResult

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: Oct 3, 2024
messagestringyes Long-TermA message explaining the test result.
successbooleanyes Long-TermTrue if the test was a success, false otherwise.