Preview email-to-alert conversion
curl --request POST \
--url 'https://api.flashcat.cloud/alert/email/preview?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"integration_id": 6113996590131,
"settings": {
"mode": "triggerOrCloseByRule",
"rules": [
{
"type": "trigger",
"extract_from": "title",
"extract_pattern": "^\\[ALERT\\]\\s*(?P<result>.*)$",
"filters": [
{
"key": "title",
"oper": "IN",
"vals": [
"/[ALERT]/"
]
}
]
},
{
"type": "close",
"extract_from": "title",
"extract_pattern": "^\\[OK\\]\\s*(?P<result>.*)$",
"filters": [
{
"key": "title",
"oper": "IN",
"vals": [
"/[OK]/"
]
}
]
}
],
"default": "discard"
},
"email": {
"subject": "[ALERT] checkout 5xx rate above 2%",
"body": "The checkout service 5xx rate is 3.4% over the last 5 minutes.",
"from": "alerts@acme.example.com"
}
}
'import requests
url = "https://api.flashcat.cloud/alert/email/preview?app_key="
payload = {
"integration_id": 6113996590131,
"settings": {
"mode": "triggerOrCloseByRule",
"rules": [
{
"type": "trigger",
"extract_from": "title",
"extract_pattern": "^\[ALERT\]\s*(?P<result>.*)$",
"filters": [
{
"key": "title",
"oper": "IN",
"vals": ["/[ALERT]/"]
}
]
},
{
"type": "close",
"extract_from": "title",
"extract_pattern": "^\[OK\]\s*(?P<result>.*)$",
"filters": [
{
"key": "title",
"oper": "IN",
"vals": ["/[OK]/"]
}
]
}
],
"default": "discard"
},
"email": {
"subject": "[ALERT] checkout 5xx rate above 2%",
"body": "The checkout service 5xx rate is 3.4% over the last 5 minutes.",
"from": "alerts@acme.example.com"
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
integration_id: 6113996590131,
settings: {
mode: 'triggerOrCloseByRule',
rules: [
{
type: 'trigger',
extract_from: 'title',
extract_pattern: '^\[ALERT\]\s*(?P<result>.*)$',
filters: [{key: 'title', oper: 'IN', vals: ['/[ALERT]/']}]
},
{
type: 'close',
extract_from: 'title',
extract_pattern: '^\[OK\]\s*(?P<result>.*)$',
filters: [{key: 'title', oper: 'IN', vals: ['/[OK]/']}]
}
],
default: 'discard'
},
email: {
subject: '[ALERT] checkout 5xx rate above 2%',
body: JSON.stringify('The checkout service 5xx rate is 3.4% over the last 5 minutes.'),
from: 'alerts@acme.example.com'
}
})
};
fetch('https://api.flashcat.cloud/alert/email/preview?app_key=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.flashcat.cloud/alert/email/preview?app_key=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'integration_id' => 6113996590131,
'settings' => [
'mode' => 'triggerOrCloseByRule',
'rules' => [
[
'type' => 'trigger',
'extract_from' => 'title',
'extract_pattern' => '^\\[ALERT\\]\\s*(?P<result>.*)$',
'filters' => [
[
'key' => 'title',
'oper' => 'IN',
'vals' => [
'/[ALERT]/'
]
]
]
],
[
'type' => 'close',
'extract_from' => 'title',
'extract_pattern' => '^\\[OK\\]\\s*(?P<result>.*)$',
'filters' => [
[
'key' => 'title',
'oper' => 'IN',
'vals' => [
'/[OK]/'
]
]
]
]
],
'default' => 'discard'
],
'email' => [
'subject' => '[ALERT] checkout 5xx rate above 2%',
'body' => 'The checkout service 5xx rate is 3.4% over the last 5 minutes.',
'from' => 'alerts@acme.example.com'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.flashcat.cloud/alert/email/preview?app_key="
payload := strings.NewReader("{\n \"integration_id\": 6113996590131,\n \"settings\": {\n \"mode\": \"triggerOrCloseByRule\",\n \"rules\": [\n {\n \"type\": \"trigger\",\n \"extract_from\": \"title\",\n \"extract_pattern\": \"^\\\\[ALERT\\\\]\\\\s*(?P<result>.*)$\",\n \"filters\": [\n {\n \"key\": \"title\",\n \"oper\": \"IN\",\n \"vals\": [\n \"/[ALERT]/\"\n ]\n }\n ]\n },\n {\n \"type\": \"close\",\n \"extract_from\": \"title\",\n \"extract_pattern\": \"^\\\\[OK\\\\]\\\\s*(?P<result>.*)$\",\n \"filters\": [\n {\n \"key\": \"title\",\n \"oper\": \"IN\",\n \"vals\": [\n \"/[OK]/\"\n ]\n }\n ]\n }\n ],\n \"default\": \"discard\"\n },\n \"email\": {\n \"subject\": \"[ALERT] checkout 5xx rate above 2%\",\n \"body\": \"The checkout service 5xx rate is 3.4% over the last 5 minutes.\",\n \"from\": \"alerts@acme.example.com\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/alert/email/preview?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"integration_id\": 6113996590131,\n \"settings\": {\n \"mode\": \"triggerOrCloseByRule\",\n \"rules\": [\n {\n \"type\": \"trigger\",\n \"extract_from\": \"title\",\n \"extract_pattern\": \"^\\\\[ALERT\\\\]\\\\s*(?P<result>.*)$\",\n \"filters\": [\n {\n \"key\": \"title\",\n \"oper\": \"IN\",\n \"vals\": [\n \"/[ALERT]/\"\n ]\n }\n ]\n },\n {\n \"type\": \"close\",\n \"extract_from\": \"title\",\n \"extract_pattern\": \"^\\\\[OK\\\\]\\\\s*(?P<result>.*)$\",\n \"filters\": [\n {\n \"key\": \"title\",\n \"oper\": \"IN\",\n \"vals\": [\n \"/[OK]/\"\n ]\n }\n ]\n }\n ],\n \"default\": \"discard\"\n },\n \"email\": {\n \"subject\": \"[ALERT] checkout 5xx rate above 2%\",\n \"body\": \"The checkout service 5xx rate is 3.4% over the last 5 minutes.\",\n \"from\": \"alerts@acme.example.com\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/alert/email/preview?app_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"integration_id\": 6113996590131,\n \"settings\": {\n \"mode\": \"triggerOrCloseByRule\",\n \"rules\": [\n {\n \"type\": \"trigger\",\n \"extract_from\": \"title\",\n \"extract_pattern\": \"^\\\\[ALERT\\\\]\\\\s*(?P<result>.*)$\",\n \"filters\": [\n {\n \"key\": \"title\",\n \"oper\": \"IN\",\n \"vals\": [\n \"/[ALERT]/\"\n ]\n }\n ]\n },\n {\n \"type\": \"close\",\n \"extract_from\": \"title\",\n \"extract_pattern\": \"^\\\\[OK\\\\]\\\\s*(?P<result>.*)$\",\n \"filters\": [\n {\n \"key\": \"title\",\n \"oper\": \"IN\",\n \"vals\": [\n \"/[OK]/\"\n ]\n }\n ]\n }\n ],\n \"default\": \"discard\"\n },\n \"email\": {\n \"subject\": \"[ALERT] checkout 5xx rate above 2%\",\n \"body\": \"The checkout service 5xx rate is 3.4% over the last 5 minutes.\",\n \"from\": \"alerts@acme.example.com\"\n }\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"result": "trigger",
"matched_rule": 0,
"key_source": "checkout 5xx rate above 2%",
"key_fallback": false,
"alert_key": "8f14e45fceea167a5a36dedd4bea2543",
"event": {
"title": "[ALERT] checkout 5xx rate above 2%",
"description": "The checkout service 5xx rate is 3.4% over the last 5 minutes.",
"event_status": "Critical",
"event_severity": "Critical",
"labels": {
"from": "alerts@acme.example.com",
"subject": "[ALERT] checkout 5xx rate above 2%"
}
},
"email": {
"subject": "[ALERT] checkout 5xx rate above 2%",
"from": "alerts@acme.example.com",
"body": "The checkout service 5xx rate is 3.4% over the last 5 minutes.",
"body_text": "The checkout service 5xx rate is 3.4% over the last 5 minutes."
}
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "AccessDenied",
"message": "Access Denied."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
}
}Integrations
Preview email-to-alert conversion
Run unsaved email integration settings over one email, the way ingestion would.
POST
/
alert
/
email
/
preview
Preview email-to-alert conversion
curl --request POST \
--url 'https://api.flashcat.cloud/alert/email/preview?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"integration_id": 6113996590131,
"settings": {
"mode": "triggerOrCloseByRule",
"rules": [
{
"type": "trigger",
"extract_from": "title",
"extract_pattern": "^\\[ALERT\\]\\s*(?P<result>.*)$",
"filters": [
{
"key": "title",
"oper": "IN",
"vals": [
"/[ALERT]/"
]
}
]
},
{
"type": "close",
"extract_from": "title",
"extract_pattern": "^\\[OK\\]\\s*(?P<result>.*)$",
"filters": [
{
"key": "title",
"oper": "IN",
"vals": [
"/[OK]/"
]
}
]
}
],
"default": "discard"
},
"email": {
"subject": "[ALERT] checkout 5xx rate above 2%",
"body": "The checkout service 5xx rate is 3.4% over the last 5 minutes.",
"from": "alerts@acme.example.com"
}
}
'import requests
url = "https://api.flashcat.cloud/alert/email/preview?app_key="
payload = {
"integration_id": 6113996590131,
"settings": {
"mode": "triggerOrCloseByRule",
"rules": [
{
"type": "trigger",
"extract_from": "title",
"extract_pattern": "^\[ALERT\]\s*(?P<result>.*)$",
"filters": [
{
"key": "title",
"oper": "IN",
"vals": ["/[ALERT]/"]
}
]
},
{
"type": "close",
"extract_from": "title",
"extract_pattern": "^\[OK\]\s*(?P<result>.*)$",
"filters": [
{
"key": "title",
"oper": "IN",
"vals": ["/[OK]/"]
}
]
}
],
"default": "discard"
},
"email": {
"subject": "[ALERT] checkout 5xx rate above 2%",
"body": "The checkout service 5xx rate is 3.4% over the last 5 minutes.",
"from": "alerts@acme.example.com"
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
integration_id: 6113996590131,
settings: {
mode: 'triggerOrCloseByRule',
rules: [
{
type: 'trigger',
extract_from: 'title',
extract_pattern: '^\[ALERT\]\s*(?P<result>.*)$',
filters: [{key: 'title', oper: 'IN', vals: ['/[ALERT]/']}]
},
{
type: 'close',
extract_from: 'title',
extract_pattern: '^\[OK\]\s*(?P<result>.*)$',
filters: [{key: 'title', oper: 'IN', vals: ['/[OK]/']}]
}
],
default: 'discard'
},
email: {
subject: '[ALERT] checkout 5xx rate above 2%',
body: JSON.stringify('The checkout service 5xx rate is 3.4% over the last 5 minutes.'),
from: 'alerts@acme.example.com'
}
})
};
fetch('https://api.flashcat.cloud/alert/email/preview?app_key=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.flashcat.cloud/alert/email/preview?app_key=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'integration_id' => 6113996590131,
'settings' => [
'mode' => 'triggerOrCloseByRule',
'rules' => [
[
'type' => 'trigger',
'extract_from' => 'title',
'extract_pattern' => '^\\[ALERT\\]\\s*(?P<result>.*)$',
'filters' => [
[
'key' => 'title',
'oper' => 'IN',
'vals' => [
'/[ALERT]/'
]
]
]
],
[
'type' => 'close',
'extract_from' => 'title',
'extract_pattern' => '^\\[OK\\]\\s*(?P<result>.*)$',
'filters' => [
[
'key' => 'title',
'oper' => 'IN',
'vals' => [
'/[OK]/'
]
]
]
]
],
'default' => 'discard'
],
'email' => [
'subject' => '[ALERT] checkout 5xx rate above 2%',
'body' => 'The checkout service 5xx rate is 3.4% over the last 5 minutes.',
'from' => 'alerts@acme.example.com'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.flashcat.cloud/alert/email/preview?app_key="
payload := strings.NewReader("{\n \"integration_id\": 6113996590131,\n \"settings\": {\n \"mode\": \"triggerOrCloseByRule\",\n \"rules\": [\n {\n \"type\": \"trigger\",\n \"extract_from\": \"title\",\n \"extract_pattern\": \"^\\\\[ALERT\\\\]\\\\s*(?P<result>.*)$\",\n \"filters\": [\n {\n \"key\": \"title\",\n \"oper\": \"IN\",\n \"vals\": [\n \"/[ALERT]/\"\n ]\n }\n ]\n },\n {\n \"type\": \"close\",\n \"extract_from\": \"title\",\n \"extract_pattern\": \"^\\\\[OK\\\\]\\\\s*(?P<result>.*)$\",\n \"filters\": [\n {\n \"key\": \"title\",\n \"oper\": \"IN\",\n \"vals\": [\n \"/[OK]/\"\n ]\n }\n ]\n }\n ],\n \"default\": \"discard\"\n },\n \"email\": {\n \"subject\": \"[ALERT] checkout 5xx rate above 2%\",\n \"body\": \"The checkout service 5xx rate is 3.4% over the last 5 minutes.\",\n \"from\": \"alerts@acme.example.com\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/alert/email/preview?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"integration_id\": 6113996590131,\n \"settings\": {\n \"mode\": \"triggerOrCloseByRule\",\n \"rules\": [\n {\n \"type\": \"trigger\",\n \"extract_from\": \"title\",\n \"extract_pattern\": \"^\\\\[ALERT\\\\]\\\\s*(?P<result>.*)$\",\n \"filters\": [\n {\n \"key\": \"title\",\n \"oper\": \"IN\",\n \"vals\": [\n \"/[ALERT]/\"\n ]\n }\n ]\n },\n {\n \"type\": \"close\",\n \"extract_from\": \"title\",\n \"extract_pattern\": \"^\\\\[OK\\\\]\\\\s*(?P<result>.*)$\",\n \"filters\": [\n {\n \"key\": \"title\",\n \"oper\": \"IN\",\n \"vals\": [\n \"/[OK]/\"\n ]\n }\n ]\n }\n ],\n \"default\": \"discard\"\n },\n \"email\": {\n \"subject\": \"[ALERT] checkout 5xx rate above 2%\",\n \"body\": \"The checkout service 5xx rate is 3.4% over the last 5 minutes.\",\n \"from\": \"alerts@acme.example.com\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/alert/email/preview?app_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"integration_id\": 6113996590131,\n \"settings\": {\n \"mode\": \"triggerOrCloseByRule\",\n \"rules\": [\n {\n \"type\": \"trigger\",\n \"extract_from\": \"title\",\n \"extract_pattern\": \"^\\\\[ALERT\\\\]\\\\s*(?P<result>.*)$\",\n \"filters\": [\n {\n \"key\": \"title\",\n \"oper\": \"IN\",\n \"vals\": [\n \"/[ALERT]/\"\n ]\n }\n ]\n },\n {\n \"type\": \"close\",\n \"extract_from\": \"title\",\n \"extract_pattern\": \"^\\\\[OK\\\\]\\\\s*(?P<result>.*)$\",\n \"filters\": [\n {\n \"key\": \"title\",\n \"oper\": \"IN\",\n \"vals\": [\n \"/[OK]/\"\n ]\n }\n ]\n }\n ],\n \"default\": \"discard\"\n },\n \"email\": {\n \"subject\": \"[ALERT] checkout 5xx rate above 2%\",\n \"body\": \"The checkout service 5xx rate is 3.4% over the last 5 minutes.\",\n \"from\": \"alerts@acme.example.com\"\n }\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"result": "trigger",
"matched_rule": 0,
"key_source": "checkout 5xx rate above 2%",
"key_fallback": false,
"alert_key": "8f14e45fceea167a5a36dedd4bea2543",
"event": {
"title": "[ALERT] checkout 5xx rate above 2%",
"description": "The checkout service 5xx rate is 3.4% over the last 5 minutes.",
"event_status": "Critical",
"event_severity": "Critical",
"labels": {
"from": "alerts@acme.example.com",
"subject": "[ALERT] checkout 5xx rate above 2%"
}
},
"email": {
"subject": "[ALERT] checkout 5xx rate above 2%",
"from": "alerts@acme.example.com",
"body": "The checkout service 5xx rate is 3.4% over the last 5 minutes.",
"body_text": "The checkout service 5xx rate is 3.4% over the last 5 minutes."
}
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "AccessDenied",
"message": "Access Denied."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
}
}Restrictions
| Aspect | Value |
|---|---|
| Rate limits | 1,000 requests/minute; 50 requests/second per account |
| Permissions | Channels Manage (on-call) or Integrations Read (on-call) or Integrations Manage (on-call) |
Usage
- Nothing is written: no integration, alert or event is created or changed.
integration_idseeds the preview with the integration’s stored address prefix; the address itself is never used, so the preview works on the create page too.settingspasses the same validator the save endpoint runs, so an unsupportedmode, ruletype,extract_fromor an invalidextract_patternfails withInvalidParameterbefore the email is parsed.- When
emlis set the message is parsed as a mail file, within the SMTP message size limit, andemailin the response shows what the parser read. eventisnullwhen the settings discard the email, andemailisnullwhen the message cannot be parsed.- In
alwaysTriggermode every email becomes its own alert:alert_keyandkey_sourcecome back empty.
Authorizations
APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.
Body
application/json
Request body of POST /alert/email/preview.
Settings to preview. They are validated the way the save endpoint validates them.
Show child attributes
Show child attributes
The email to convert.
Show child attributes
Show child attributes
Email integration whose saved settings seed the preview. 0 or omitted is what the console sends on the create page, before the integration exists.
Response
Success
Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.
Was this page helpful?