Skip to main content
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>'
{
  "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

​
X-API-Key
string
required
Your API key for authentication.
​
X-Organization-Id
string
required
The organization ID.
​
Content-Type
string
required
Must be application/json.

​
Path Parameters

​
integration_id
string
required
The unique identifier of the integration (format: intg_[a-f0-9]{12}).

​
Permissions

  • integrations:read (all roles)

​
Response

​
success
boolean
Indicates if the request was successful.
​
message
string
Human-readable message indicating validation result.
​
data
object
The integration object with updated status.
{
  "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"
  }
}