Send test notification
curl --request POST \
--url https://api.cloud.corbado.io/v1/observe/alertContactPoints/{alertContactPointID}/integrations/{alertContactPointIntegrationID}/test \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cloud.corbado.io/v1/observe/alertContactPoints/{alertContactPointID}/integrations/{alertContactPointIntegrationID}/test"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.cloud.corbado.io/v1/observe/alertContactPoints/{alertContactPointID}/integrations/{alertContactPointIntegrationID}/test', 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.cloud.corbado.io/v1/observe/alertContactPoints/{alertContactPointID}/integrations/{alertContactPointIntegrationID}/test",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.cloud.corbado.io/v1/observe/alertContactPoints/{alertContactPointID}/integrations/{alertContactPointIntegrationID}/test"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.cloud.corbado.io/v1/observe/alertContactPoints/{alertContactPointID}/integrations/{alertContactPointIntegrationID}/test")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloud.corbado.io/v1/observe/alertContactPoints/{alertContactPointID}/integrations/{alertContactPointIntegrationID}/test")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"results": [
{
"target": "<string>",
"success": true,
"errorMessage": "<string>"
}
]
}{
"error": {
"message": "Validation failed",
"details": [
{
"field": "projectID",
"message": "required"
}
]
}
}Alert management
Send test notification
Sends a test notification through one integration right away, whatever its status, minimum severity or the contact point’s delivery hours, and reports per destination whether it was delivered. Test notifications do not appear in the delivery log.
Required API key permission: observe:alerts:write.
POST
/
observe
/
alertContactPoints
/
{alertContactPointID}
/
integrations
/
{alertContactPointIntegrationID}
/
test
Send test notification
curl --request POST \
--url https://api.cloud.corbado.io/v1/observe/alertContactPoints/{alertContactPointID}/integrations/{alertContactPointIntegrationID}/test \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cloud.corbado.io/v1/observe/alertContactPoints/{alertContactPointID}/integrations/{alertContactPointIntegrationID}/test"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.cloud.corbado.io/v1/observe/alertContactPoints/{alertContactPointID}/integrations/{alertContactPointIntegrationID}/test', 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.cloud.corbado.io/v1/observe/alertContactPoints/{alertContactPointID}/integrations/{alertContactPointIntegrationID}/test",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.cloud.corbado.io/v1/observe/alertContactPoints/{alertContactPointID}/integrations/{alertContactPointIntegrationID}/test"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.cloud.corbado.io/v1/observe/alertContactPoints/{alertContactPointID}/integrations/{alertContactPointIntegrationID}/test")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cloud.corbado.io/v1/observe/alertContactPoints/{alertContactPointID}/integrations/{alertContactPointIntegrationID}/test")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"results": [
{
"target": "<string>",
"success": true,
"errorMessage": "<string>"
}
]
}{
"error": {
"message": "Validation failed",
"details": [
{
"field": "projectID",
"message": "required"
}
]
}
}Authorizations
Use an Observe API key from the management console. The key selects the project and must grant the permission listed on the operation. Keep this key on your server.
Path Parameters
Alert contact point ID (format acp-<number>).
Integration ID (format aci-<number>).
Response
How the test notification went, per destination.
One entry per destination of the integration - per address for email, one for a webhook or PagerDuty.
Show child attributes
Show child attributes
Was this page helpful?