testEmailAction()

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!

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

Show:

graphql

mutation {
  testEmailAction( input: 
    { viewName: "humio",
      name: "email-admin",
      recipients: [ "bob@company.com" ],
      useProxy: false,
      triggerName: "fire",
      eventData: "[{\"#type\":\"kv\"}]",
      } )
  { success }
}

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

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

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 } ^
}" ^
} '

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

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  testEmailAction( input: 
    { viewName: \"humio\",
      name: \"email-admin\",
      recipients: [ \"bob@company.com\" ],
      useProxy: false,
      triggerName: \"fire\",
      eventData: \"[{\\"#type\\":\\"kv\\"}]\",
      } )
  { success }
}"
}';
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

#! /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)

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/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

Show:

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

Parameter	Type	Required	Default	Description
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 28, 2025
`attachCsv`	boolean		false	Whether the result set should be be attached as a CSV file.
`bodyTemplate`	string			The body of the email. Can be templated with values from the result.
`eventData`	string	yes		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.
`name`	string	yes		The name of the action.
`recipients`	[string]	yes		A list of email addresses where to send an email.
`subjectTemplate`	string			The subject of the email. Can be templated with values from the result.
`triggerName`	string	yes		The name of the action. This is a mock value. The trigger doesn't have to exist.
`useProxy`	boolean	yes		Defines whether the action should use the configured proxy to make web requests.
`viewName`	string	yes		The 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

Parameter	Type	Required	Stability	Description
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: Oct 3, 2024
`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.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes