createEmailAction()

Summary

Rather than having to open the UI at regular intervals to monitor your servers, you can create a stored action that will email you or others when certain conditions occur, with a message and other information you choose. To create an email action in LogScale, you can use the createEmailAction() GraphQL mutation.

Be aware that an action is not triggered on its own. Instead, you'll have to create a legacy alert, an aggregate alert, a filtered alert, or a scheduled search that you'll use to monitor a LogScale search domain and to set the criteria necessary to trigger any actions you'd designate.

To ensure the parameters of an email action will work, you can experiment with the testEmailAction() mutation — but it won't test an existing email action. However, these two mutations are tied together in the UI. Only through the UI can you create an action, test it, and then save it.

You can use the updateEmailAction() to update an existing email action. You can use deleteActionV2() to delete one. You can add labels to actions with the addActionLabels() mutation.

Hide Query Example

Show Email Actions Query

To get a list of email actions for a repository, you could use the repository() query like so:

graphql

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

For more information on creating email actions, see the Action Type: Email documentation page. You may also want to look at the Actions page for related information.

API Stability	`Long-Term`
Security Requirement & Control	`CreateActions` API permission

Syntax

graphql

createEmailAction(
      input: CreateEmailAction!
   ): EmailAction!

For the input, you'll have to give a list of addresses for who should be emailed, indicate whether to use a proxy, and the name of the related respository or view. See the Input Parameters section for details.

For the results, you can get information on the action, including the unique identifier to use with other mutations and queries. See the Returned Values section for more.

Example

Raw

graphql

mutation {
  createEmailAction(input:
      { viewName: "humio",
        name: "my-mail-act",
        recipients: ["bob@company.com"],
        useProxy: false
      } )
  { id, recipients }
}

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 {
  createEmailAction(input:
      { viewName: \"humio\",
        name: \"my-mail-act\",
        recipients: [\"bob@company.com\"],
        useProxy: false
      } )
  { id, recipients }
}"
}
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 {
  createEmailAction(input:
      { viewName: \"humio\",
        name: \"my-mail-act\",
        recipients: [\"bob@company.com\"],
        useProxy: false
      } )
  { id, recipients }
}"
}
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 { ^
  createEmailAction(input: ^
      { viewName: \"humio\", ^
        name: \"my-mail-act\", ^
        recipients: [\"bob@company.com\"], ^
        useProxy: false ^
      } ) ^
  { id, recipients } ^
}" ^
} '

Windows Powershell and curl

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  createEmailAction(input:
      { viewName: \"humio\",
        name: \"my-mail-act\",
        recipients: [\"bob@company.com\"],
        useProxy: false
      } )
  { id, recipients }
}"
}'
    "$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 {
  createEmailAction(input:
      { viewName: \"humio\",
        name: \"my-mail-act\",
        recipients: [\"bob@company.com\"],
        useProxy: false
      } )
  { id, recipients }
}";
$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 {
  createEmailAction(input:
      { viewName: \"humio\",
        name: \"my-mail-act\",
        recipients: [\"bob@company.com\"],
        useProxy: false
      } )
  { id, recipients }
}"
}'''

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 {
  createEmailAction(input:
      { viewName: \"humio\",
        name: \"my-mail-act\",
        recipients: [\"bob@company.com\"],
        useProxy: false
      } )
  { id, recipients }
}"
}
);


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": {
    "createEmailAction": {
      "id": "abc123",
      "recipients": [
        "bob@company.com"
      ]
    }
  }
}

Input Parameters

For the input, you would provide the name of the view associated with the action to create, the email subject and message, and a list of recipients to get the email and their email addresses, and a few other items. These are listed and explained, along with other parameters, in the table below:

Table: CreateEmailAction Input Datatype

Parameter	Type	Required	Default	Stability	Description
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Mar 25, 2026
attachCsv	string		false	`Long-Term`	Whether the result set should be attached as a CSV file.
bodyTemplate	string			`Long-Term`	The body of the email. Can be templated with values from the result.
labels	[string]			`Long-Term`	A set of labels by which to categorize the action.
name	string	yes		`Long-Term`	The name of the action.
recipients	[string]	yes		`Long-Term`	A list of email addresses where to send an email.
subjectTemplate	string			`Long-Term`	The subject of the email. Can be templated with values from the result.
useProxy	boolean	yes		`Long-Term`	Whether the action should use the configured proxy to make web requests.
viewName	string	yes		`Long-Term`	The name of the view or repository to which the action is attached.

Returned Values

For the results, you can get a list allowed actions, when the action was created and modified last and by whom, and other items. Of course, having just created the action using this mutation, you'll probably know all of this except for the id. For anything you don't know, check the table below:

Table: EmailAction Datatype

Parameter	Type	Required	Stability	Description
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 30, 2025
allowedActions	[AssetAction]	yes	`Short-Term`	The allowed asset actions. See AssetAction . This is a preview feature. Changes may occur.
attachCsv	boolean	yes	`Long-Term`	Whether the result set should be attached as a CSV file.
bodyTemplate	string		`Long-Term`	Body of the email. Can be templated with values from the result.
createdInfo	AssetCommitMetadata		`Long-Term`	Metadata related to the creation of the action. See AssetCommitMetadata.
displayName	string	yes	`Long-Term`	The display name of the action.
id	string	yes	`Long-Term`	The unique identifier of the action.
isAllowedToRun	boolean	yes	`Long-Term`	False if this type of action is disabled because of a security policy.
labels	[string]		`Preview`	The labels associated with the action, if any.
modifiedInfo	AssetCommitMetadata		`Long-Term`	Metadata related to the latest modification of the action. See AssetCommitMetadata.
name	string	yes	`Long-Term`	The name of the action.
package	PackageInstallation		`Long-Term`	The package which the action is part. See PackageInstallation.
packageId	VersionedPackageSpecifier		`Long-Term`	The package version. VersionedPackageSpecifier is a scalar.
recipients	[string]	yes	`Long-Term`	List of email addresses to send an email.
requiresOrganizationOwnedQueriesPermissionToEdit	boolean	yes	`Long-Term`	True 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.
resource	string	yes	`Short-Term`	The resource identifier for the action.
subjectTemplate	string		`Long-Term`	Subject of the email. Can be templated with values from the result.
useProxy	boolean	yes	`Long-Term`	Defines whether the action should use the configured proxy to make web requests.
yamlTemplate	YAML	yes	`Long-Term`	A template that can be used to recreate the action. YAML is a scalar.

Versions of this Page

GraphQL Mutations

GraphQL API

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes