notify()

API Stability	`Long-Term`

The notify() GraphQL mutation is used to create a notification. The required permission depends on target.

For more information on actions, previously known as notifiers, see the Actions documentation page.

Syntax

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

graphql

notify(
     input: NotificationInput!
   ): Notification!

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

Show:

graphql

mutation {
  notify( input: {
         dismissable: true,
         title: "Ding",
         message: "Hey! Wake up!",
         target: All
         severity: Info,
         notificationType: Bell,
  } )
  {id}
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  notify( input: {
         dismissable: true,
         title: \"Ding\",
         message: \"Hey! Wake up!\",
         target: All
         severity: Info,
         notificationType: Bell,
  } )
  {id}
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  notify( input: {
         dismissable: true,
         title: \"Ding\",
         message: \"Hey! Wake up!\",
         target: All
         severity: Info,
         notificationType: Bell,
  } )
  {id}
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  notify( input: { ^
         dismissable: true, ^
         title: \"Ding\", ^
         message: \"Hey! Wake up!\", ^
         target: All ^
         severity: Info, ^
         notificationType: Bell, ^
  } ) ^
  {id} ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  notify( input: {
         dismissable: true,
         title: \"Ding\",
         message: \"Hey! Wake up!\",
         target: All
         severity: Info,
         notificationType: Bell,
  } )
  {id}
}"
}'
    "$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 {
  notify( input: {
         dismissable: true,
         title: \"Ding\",
         message: \"Hey! Wake up!\",
         target: All
         severity: Info,
         notificationType: Bell,
  } )
  {id}
}"
}';
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 {
  notify( input: {
         dismissable: true,
         title: \"Ding\",
         message: \"Hey! Wake up!\",
         target: All
         severity: Info,
         notificationType: Bell,
  } )
  {id}
}"
}'''

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 {
  notify( input: {
         dismissable: true,
         title: \"Ding\",
         message: \"Hey! Wake up!\",
         target: All
         severity: Info,
         notificationType: Bell,
  } )
  {id}
}"
}
);


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": {
    "notify": {
      "id": "PZ5VTHfaNMQASqpO78JDUidFTtsnjXfS"
    }
  }
}

Given Datatypes

For NotificationInput, there are several parameters. Below is a list of them and a description of each:

Table: NotificationInput

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: Sep 19, 2024
`dismissable`	boolean	yes	`Long-Term`	Whether the notification is dismissable by the user.
`ids`	[string]	yes	`Long-Term`	The unique identifiers of the notifications.
`link`	string		`Long-Term`	A link that may be included, if preferred, in the notification.
`linkDescription`	string		`Long-Term`	A description of the link given in the notification.
`message`	string	yes	`Long-Term`	The message to be used when notifying.
`notificationType`	`NotificationTypes`	yes	`Long-Term`	The type of notification. See `NotificationTypes`.
`severity`	`NotificationSeverity`	yes	`Long-Term`	The severity level of the notification. See `NotificationSeverity`.
`target`	`Targets`	yes	`Long-Term`	The target users for the notification. See `Targets`.
`title`	string	yes	`Long-Term`	The title for the notification.

Returned Datatypes

The returned datatype Notification has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: Notification

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: Sep 26, 2024
`dismissable`	boolean	yes	`Long-Term`	Whether the notification is dismissable.
`id`	string	yes	`Long-Term`	The unique identifier for the notification.
`link`	string		`Long-Term`	Link accompanying the notification.
`linkDescription`	string	yes	`Long-Term`	A description for the link.
`message`	string	yes	`Long-Term`	The message for the notification.
`severity`	`NotificationSeverity`	yes	`Long-Term`	The severity of the notification. See `NotificationSeverity`.
`title`	string	yes	`Long-Term`	The title or heading of the notification.
`type`	`NotificationTypes`	yes	`Long-Term`	The type of the notification. See `NotificationTypes`.

Examples

Notify users in group1 and group2

mutation{notify(Target:Group, ids: ["GroupId1", "GroupId2"],...)}

Notify org roots in org1 and org2

mutation{notify(Target:OrgRoot, ids: ["OrgId1", "OrgId2"],...)}

Notify all root users

mutation{notify(Target:Root,...)}

Notify all users

mutation{notify(Target:All,...)}

Notify user 1, 2 & 3

mutation{notify(Target:All,["UserId1", "UserId2", "UserId3"],...)}

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes

notify()

Syntax

Given Datatypes

Returned Datatypes

Examples

Enter search term