Validate Integration
curl --request POST \
--url https://api.example.com/api/integrations/{integration_id}/validate \
--header 'Content-Type: <content-type>' \
--header 'X-API-Key: <x-api-key>' \
--header 'X-Organization-Id: <x-organization-id>'import requests
url = "https://api.example.com/api/integrations/{integration_id}/validate"
headers = {
"X-API-Key": "<x-api-key>",
"X-Organization-Id": "<x-organization-id>",
"Content-Type": "<content-type>"
}
response = requests.post(url, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-API-Key': '<x-api-key>',
'X-Organization-Id': '<x-organization-id>',
'Content-Type': '<content-type>'
}
};
fetch('https://api.example.com/api/integrations/{integration_id}/validate', 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.example.com/api/integrations/{integration_id}/validate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Content-Type: <content-type>",
"X-API-Key: <x-api-key>",
"X-Organization-Id: <x-organization-id>"
],
]);
$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.example.com/api/integrations/{integration_id}/validate"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-API-Key", "<x-api-key>")
req.Header.Add("X-Organization-Id", "<x-organization-id>")
req.Header.Add("Content-Type", "<content-type>")
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.example.com/api/integrations/{integration_id}/validate")
.header("X-API-Key", "<x-api-key>")
.header("X-Organization-Id", "<x-organization-id>")
.header("Content-Type", "<content-type>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/integrations/{integration_id}/validate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<x-api-key>'
request["X-Organization-Id"] = '<x-organization-id>'
request["Content-Type"] = '<content-type>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Integration credentials are active",
"data": {
"integration_id": "intg_a1b2c3d4e5f6",
"client_id": "org_abc123",
"name": "Twilio Production",
"provider": "twilio",
"category": "telephony",
"status": "active",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T11:00:00Z"
}
}
Integrations
Validate Integration
POST
/
api
/
integrations
/
{integration_id}
/
validate
Validate Integration
curl --request POST \
--url https://api.example.com/api/integrations/{integration_id}/validate \
--header 'Content-Type: <content-type>' \
--header 'X-API-Key: <x-api-key>' \
--header 'X-Organization-Id: <x-organization-id>'import requests
url = "https://api.example.com/api/integrations/{integration_id}/validate"
headers = {
"X-API-Key": "<x-api-key>",
"X-Organization-Id": "<x-organization-id>",
"Content-Type": "<content-type>"
}
response = requests.post(url, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-API-Key': '<x-api-key>',
'X-Organization-Id': '<x-organization-id>',
'Content-Type': '<content-type>'
}
};
fetch('https://api.example.com/api/integrations/{integration_id}/validate', 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.example.com/api/integrations/{integration_id}/validate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Content-Type: <content-type>",
"X-API-Key: <x-api-key>",
"X-Organization-Id: <x-organization-id>"
],
]);
$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.example.com/api/integrations/{integration_id}/validate"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-API-Key", "<x-api-key>")
req.Header.Add("X-Organization-Id", "<x-organization-id>")
req.Header.Add("Content-Type", "<content-type>")
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.example.com/api/integrations/{integration_id}/validate")
.header("X-API-Key", "<x-api-key>")
.header("X-Organization-Id", "<x-organization-id>")
.header("Content-Type", "<content-type>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/integrations/{integration_id}/validate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<x-api-key>'
request["X-Organization-Id"] = '<x-organization-id>'
request["Content-Type"] = '<content-type>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Integration credentials are active",
"data": {
"integration_id": "intg_a1b2c3d4e5f6",
"client_id": "org_abc123",
"name": "Twilio Production",
"provider": "twilio",
"category": "telephony",
"status": "active",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T11:00:00Z"
}
}
Validate the stored credentials for an integration by making a test API call to the provider. This updates the integration’s status to
active if credentials are valid, or invalid if they fail validation.
Headers
string
required
Your API key for authentication.
string
required
The organization ID.
string
required
Must be
application/json.Path Parameters
string
required
The unique identifier of the integration (format:
intg_[a-f0-9]{12}).Permissions
integrations:read(all roles)
Response
boolean
Indicates if the request was successful.
string
Human-readable message indicating validation result.
object
The integration object with updated status.
Show properties
Show properties
string
Unique integration identifier.
string
The organization/client ID this integration belongs to.
string
The name of the integration.
string
The provider type (e.g.,
twilio).string
The category (e.g.,
telephony).string
Updated status (
active if validation succeeded, invalid if failed).string
ISO 8601 timestamp of creation.
string
ISO 8601 timestamp of last update.
{
"success": true,
"message": "Integration credentials are active",
"data": {
"integration_id": "intg_a1b2c3d4e5f6",
"client_id": "org_abc123",
"name": "Twilio Production",
"provider": "twilio",
"category": "telephony",
"status": "active",
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T11:00:00Z"
}
}
⌘I