curl --request POST \
--url https://api.messaging.phonovation.com/subscriptions/1/certificates/test/webhook \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"certificateId": "my-certificate-1",
"webhookUrl": "https://example.com/webhook-url"
}
'import requests
url = "https://api.messaging.phonovation.com/subscriptions/1/certificates/test/webhook"
payload = {
"certificateId": "my-certificate-1",
"webhookUrl": "https://example.com/webhook-url"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.messaging.phonovation.com/subscriptions/1/certificates/test/webhook");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
request.AddJsonBody("{\n \"certificateId\": \"my-certificate-1\",\n \"webhookUrl\": \"https://example.com/webhook-url\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
HttpResponse<String> response = Unirest.post("https://api.messaging.phonovation.com/subscriptions/1/certificates/test/webhook")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"certificateId\": \"my-certificate-1\",\n \"webhookUrl\": \"https://example.com/webhook-url\"\n}")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.messaging.phonovation.com/subscriptions/1/certificates/test/webhook",
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([
'certificateId' => 'my-certificate-1',
'webhookUrl' => 'https://example.com/webhook-url'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
certificateId: 'my-certificate-1',
webhookUrl: 'https://example.com/webhook-url'
})
};
fetch('https://api.messaging.phonovation.com/subscriptions/1/certificates/test/webhook', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"certificateId": "my-certificate-1",
"webhookUrl": "https://example.com/my-webhook",
"result": "SUCCESS"
}Test connection to a webhook
Performs connectivity check to provided webhook with the given certificate. Note, it does not send a notification event.
Required scope: Enable one of: subscriptions:manage.
curl --request POST \
--url https://api.messaging.phonovation.com/subscriptions/1/certificates/test/webhook \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"certificateId": "my-certificate-1",
"webhookUrl": "https://example.com/webhook-url"
}
'import requests
url = "https://api.messaging.phonovation.com/subscriptions/1/certificates/test/webhook"
payload = {
"certificateId": "my-certificate-1",
"webhookUrl": "https://example.com/webhook-url"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://api.messaging.phonovation.com/subscriptions/1/certificates/test/webhook");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
request.AddJsonBody("{\n \"certificateId\": \"my-certificate-1\",\n \"webhookUrl\": \"https://example.com/webhook-url\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
HttpResponse<String> response = Unirest.post("https://api.messaging.phonovation.com/subscriptions/1/certificates/test/webhook")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"certificateId\": \"my-certificate-1\",\n \"webhookUrl\": \"https://example.com/webhook-url\"\n}")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.messaging.phonovation.com/subscriptions/1/certificates/test/webhook",
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([
'certificateId' => 'my-certificate-1',
'webhookUrl' => 'https://example.com/webhook-url'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
certificateId: 'my-certificate-1',
webhookUrl: 'https://example.com/webhook-url'
})
};
fetch('https://api.messaging.phonovation.com/subscriptions/1/certificates/test/webhook', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"certificateId": "my-certificate-1",
"webhookUrl": "https://example.com/my-webhook",
"result": "SUCCESS"
}Authorizations
This is the most secure authorization type and the one with the most flexibility.
API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.
You can manage your API keys from GUI, or programmatically with dedicated API.
API key Authorization header example:
Authorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9
Body
Response
Success.
Existing certificate identifier.
A webhook URL over which a connectivity test will be performed.
Connection test result. Indicates whether the test to connection passed.
SUCCESS, FAIL Contains reasons why the connection test was failed.
Contains reasons why the connection test was failed.
Contains a hint how the client can fix the errors.