预览邮件转告警效果
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."
}
}集成中心
预览邮件转告警效果
用未保存的邮件集成配置，按接入的方式处理一封邮件，返回判定结果与生成的事件。
POST
/
alert
/
email
/
preview
预览邮件转告警效果
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."
}
}限制说明
| 项目 | 说明 |
|---|---|
| 速率限制 | 每个账户 1,000 次/分钟；50 次/秒 |
| 权限要求 | 协作空间管理（on-call）或 集成中心查看（on-call）或 集成中心管理（on-call） |
使用说明
- 不会写入任何数据：不创建也不修改集成、告警或事件。
integration_id只用于带入该集成已存的地址前缀；地址本身不参与处理，因此在新建页面同样可用。settings会走保存接口同一套校验：不支持的mode、规则type、extract_from或非法的extract_pattern会在解析邮件之前就返回InvalidParameter。- 提供
eml时按邮件文件解析，并受 SMTP 邮件大小上限约束；响应中的email展示解析器实际读到的内容。 - 配置丢弃该邮件时
event为null；邮件无法解析时email为null。 alwaysTrigger模式下每封邮件都是独立告警，alert_key与key_source返回空。
授权
在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集，请妥善保管。
请求体
application/json
此页面对您有帮助吗？