Create/update the per-org template override (validates + increments version)
curl --request PUT \
--url https://api-sandbox.featherhq.com/v1/notifications/types/{event_type}/template \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"title": "<string>",
"body": "",
"fields": [
{
"label": "<string>",
"value": "<string>"
}
],
"link_text": "<string>",
"link_url": "<string>"
}
'import requests
url = "https://api-sandbox.featherhq.com/v1/notifications/types/{event_type}/template"
payload = {
"title": "<string>",
"body": "",
"fields": [
{
"label": "<string>",
"value": "<string>"
}
],
"link_text": "<string>",
"link_url": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
body: JSON.stringify(''),
fields: [{label: '<string>', value: '<string>'}],
link_text: '<string>',
link_url: '<string>'
})
};
fetch('https://api-sandbox.featherhq.com/v1/notifications/types/{event_type}/template', 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-sandbox.featherhq.com/v1/notifications/types/{event_type}/template",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'body' => '',
'fields' => [
[
'label' => '<string>',
'value' => '<string>'
]
],
'link_text' => '<string>',
'link_url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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-sandbox.featherhq.com/v1/notifications/types/{event_type}/template"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"body\": \"\",\n \"fields\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"link_text\": \"<string>\",\n \"link_url\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.put("https://api-sandbox.featherhq.com/v1/notifications/types/{event_type}/template")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"body\": \"\",\n \"fields\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"link_text\": \"<string>\",\n \"link_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.featherhq.com/v1/notifications/types/{event_type}/template")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"body\": \"\",\n \"fields\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"link_text\": \"<string>\",\n \"link_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"event_type": "<string>",
"channel_kind": "<string>",
"source": "<string>",
"slots": {
"title": "<string>",
"body": "",
"fields": [
{
"label": "<string>",
"value": "<string>"
}
],
"link_text": "<string>",
"link_url": "<string>"
},
"version": 123,
"default_slots": {
"title": "<string>",
"body": "",
"fields": [
{
"label": "<string>",
"value": "<string>"
}
],
"link_text": "<string>",
"link_url": "<string>"
},
"variables": {}
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Path Parameters
Query Parameters
The messaging channel a destination delivers through.
slack is the only kind in v1. New kinds are additive — add a member
here, a provider class, and a PROVIDER_REGISTRY entry.
slack Body
The four authorable slots. extra="forbid" so an operator can't smuggle
unknown keys past validation (mirrors the catalog's threshold configs).
Response
Successful Response
The effective template for an (org, type, channel): the slots that render, where they came from, the platform default, and the variables manifest.
The four authorable slots. extra="forbid" so an operator can't smuggle
unknown keys past validation (mirrors the catalog's threshold configs).
Show child attributes
Show child attributes
The four authorable slots. extra="forbid" so an operator can't smuggle
unknown keys past validation (mirrors the catalog's threshold configs).
Show child attributes
Show child attributes
Was this page helpful?
curl --request PUT \
--url https://api-sandbox.featherhq.com/v1/notifications/types/{event_type}/template \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"title": "<string>",
"body": "",
"fields": [
{
"label": "<string>",
"value": "<string>"
}
],
"link_text": "<string>",
"link_url": "<string>"
}
'import requests
url = "https://api-sandbox.featherhq.com/v1/notifications/types/{event_type}/template"
payload = {
"title": "<string>",
"body": "",
"fields": [
{
"label": "<string>",
"value": "<string>"
}
],
"link_text": "<string>",
"link_url": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
body: JSON.stringify(''),
fields: [{label: '<string>', value: '<string>'}],
link_text: '<string>',
link_url: '<string>'
})
};
fetch('https://api-sandbox.featherhq.com/v1/notifications/types/{event_type}/template', 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-sandbox.featherhq.com/v1/notifications/types/{event_type}/template",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'body' => '',
'fields' => [
[
'label' => '<string>',
'value' => '<string>'
]
],
'link_text' => '<string>',
'link_url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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-sandbox.featherhq.com/v1/notifications/types/{event_type}/template"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"body\": \"\",\n \"fields\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"link_text\": \"<string>\",\n \"link_url\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.put("https://api-sandbox.featherhq.com/v1/notifications/types/{event_type}/template")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"body\": \"\",\n \"fields\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"link_text\": \"<string>\",\n \"link_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.featherhq.com/v1/notifications/types/{event_type}/template")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"body\": \"\",\n \"fields\": [\n {\n \"label\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"link_text\": \"<string>\",\n \"link_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"event_type": "<string>",
"channel_kind": "<string>",
"source": "<string>",
"slots": {
"title": "<string>",
"body": "",
"fields": [
{
"label": "<string>",
"value": "<string>"
}
],
"link_text": "<string>",
"link_url": "<string>"
},
"version": 123,
"default_slots": {
"title": "<string>",
"body": "",
"fields": [
{
"label": "<string>",
"value": "<string>"
}
],
"link_text": "<string>",
"link_url": "<string>"
},
"variables": {}
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"error": "<string>",
"message": "<string>",
"retryable": true,
"retry_after": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}