createEmailAction()

API Stability	`Long-Term`

The createEmailAction() GraphQL mutation may be used to create an email action in LogScale.

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.

Syntax

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

graphql

createEmailAction(
      input: CreateEmailAction!
   ): EmailAction!

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

Show:

graphql

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

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

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

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

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

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

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

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

Given Datatypes

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

Table: CreateEmailAction

Parameter	Type	Required	Default	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: Mar 28, 2025
`attachCsv`	string	yes	false	`Long-Term`	Whether the result set should be be attached as a CSV file.
`bodyTemplate`	string	yes		`Long-Term`	Body of the email. Can be templated with values from the result.
`name`	string	yes		`Long-Term`	Name of the action.
`recipients`	[string]	yes		`Long-Term`	List of email addresses where to send an email.
`subjectTemplate`	string			`Long-Term`	Subject of the email. Can be templated with values from the result.
`useProxy`	string	yes		`Long-Term`	Defines whether the action should use the configured proxy to make web requests.
`viewName`	string	yes		`Long-Term`	Name of the view of the action.

Returned Datatypes

The returned datatype EmailAction has many parameters. Below is a list of them along with a description of each:

Table: EmailAction

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: Mar 26, 2025
`allowedActions`	[`AssetAction`]	yes	`Preview`	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.
`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.
`name`	string	yes	`Long-Term`	The name of the action.
`package`	`PackageInstallation`		`Long-Term`	The package which the action is part. See `PackageInstallation`.
`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.
`subjectTemplate`	string		`Long-Term`	Subject of the email. Can be templated with values from the result.
`resource`	string	yes	`Short-Term`	The resource identifier for the action.
`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.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes