curl --request POST \
--url 'https://api.flashcat.cloud/channel/integration/create?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"channel_id": 20001,
"plugin_type": "standard.alert",
"name": "Payments alerts",
"description": "Alerts for the payments channel",
"settings": {}
}
'import requests
url = "https://api.flashcat.cloud/channel/integration/create?app_key="
payload = {
"channel_id": 20001,
"plugin_type": "standard.alert",
"name": "Payments alerts",
"description": "Alerts for the payments channel",
"settings": {}
}
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({
channel_id: 20001,
plugin_type: 'standard.alert',
name: 'Payments alerts',
description: 'Alerts for the payments channel',
settings: {}
})
};
fetch('https://api.flashcat.cloud/channel/integration/create?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/channel/integration/create?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([
'channel_id' => 20001,
'plugin_type' => 'standard.alert',
'name' => 'Payments alerts',
'description' => 'Alerts for the payments channel',
'settings' => [
]
]),
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/channel/integration/create?app_key="
payload := strings.NewReader("{\n \"channel_id\": 20001,\n \"plugin_type\": \"standard.alert\",\n \"name\": \"Payments alerts\",\n \"description\": \"Alerts for the payments channel\",\n \"settings\": {}\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/channel/integration/create?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"channel_id\": 20001,\n \"plugin_type\": \"standard.alert\",\n \"name\": \"Payments alerts\",\n \"description\": \"Alerts for the payments channel\",\n \"settings\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/channel/integration/create?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 \"channel_id\": 20001,\n \"plugin_type\": \"standard.alert\",\n \"name\": \"Payments alerts\",\n \"description\": \"Alerts for the payments channel\",\n \"settings\": {}\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"integration_id": 10001,
"integration_key": "0123456789abcdef0123456789abcdef100"
}
}{
"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": "RequestLocked",
"message": "Channel integration is being changed, please try again"
}
}{
"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."
}
}Create dedicated integration
Create a dedicated alert integration for an enabled channel.
curl --request POST \
--url 'https://api.flashcat.cloud/channel/integration/create?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"channel_id": 20001,
"plugin_type": "standard.alert",
"name": "Payments alerts",
"description": "Alerts for the payments channel",
"settings": {}
}
'import requests
url = "https://api.flashcat.cloud/channel/integration/create?app_key="
payload = {
"channel_id": 20001,
"plugin_type": "standard.alert",
"name": "Payments alerts",
"description": "Alerts for the payments channel",
"settings": {}
}
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({
channel_id: 20001,
plugin_type: 'standard.alert',
name: 'Payments alerts',
description: 'Alerts for the payments channel',
settings: {}
})
};
fetch('https://api.flashcat.cloud/channel/integration/create?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/channel/integration/create?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([
'channel_id' => 20001,
'plugin_type' => 'standard.alert',
'name' => 'Payments alerts',
'description' => 'Alerts for the payments channel',
'settings' => [
]
]),
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/channel/integration/create?app_key="
payload := strings.NewReader("{\n \"channel_id\": 20001,\n \"plugin_type\": \"standard.alert\",\n \"name\": \"Payments alerts\",\n \"description\": \"Alerts for the payments channel\",\n \"settings\": {}\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/channel/integration/create?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"channel_id\": 20001,\n \"plugin_type\": \"standard.alert\",\n \"name\": \"Payments alerts\",\n \"description\": \"Alerts for the payments channel\",\n \"settings\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/channel/integration/create?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 \"channel_id\": 20001,\n \"plugin_type\": \"standard.alert\",\n \"name\": \"Payments alerts\",\n \"description\": \"Alerts for the payments channel\",\n \"settings\": {}\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"integration_id": 10001,
"integration_key": "0123456789abcdef0123456789abcdef100"
}
}{
"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": "RequestLocked",
"message": "Channel integration is being changed, please try again"
}
}{
"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 | 300 requests/minute; 20 requests/second per account |
| Permissions | Channels Manage (on-call) |
Usage
- These APIs manage channel-owned dedicated integrations; use
/integration/*for public integrations. - The App Key’s
api_scopesmust allow the operation; permissions follow the user who owns the key. - You also need management access to the target channel: the account owner, an Admin, the channel creator, or a managing-team member. The owning team applies when no managing team is set.
- Creating the integration does not independently grant channel management access; Integrations Manage does not grant access to this endpoint.
- The channel must be enabled; the integration type must be enabled, belong to
event.alert, and be supported by your subscription. - If you know the
plugin_type, create the integration directly without querying types first. You can optionally queryPOST /integration/type/listfor alert types with Channels Read, Channels Manage, or Integrations Read; the App Key’sapi_scopesmust also allowintegration.api:read:typeList. - An omitted
nameuses the integration type default; an omittedintegration_keyis generated. A supplied key must have 35 characters, match the account suffix, and not be used by another integration. - Success returns
integration_idandintegration_key; use thatintegration_idfor subsequent operations. - Every call is recorded in the account audit log.
- Concurrent changes to integrations in the same channel return
RequestLocked; retry after the current change completes.
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
Creates a dedicated integration in an enabled channel.
Target channel ID; the channel must be enabled.
x >= 120001
Enabled alert integration type identifier, such as standard.alert.
Integration name, 2–49 characters when supplied; omitted or empty uses the integration type default.
Description, at most 499 characters.
499Optional supplied integration key. A non-empty value must have 35 characters, match the account suffix, and be unique.
Integration-type-specific configuration; saved secret values in responses are masked as ******.
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?