Test an OAuth connection

Attempts to retrieve a valid provider token for the selected workspace connection.

POST

https://api.channelautomation.com/api/oauth/connections/{id}/test

Authorization

BearerAuth
optional
HTTP Bearer (JWT)

ApiKeyAuth
optional
API key in header

Path parameters

id
string
required
format: uuid

Header parameters

x-workspace-id
string
required

Returns

200

Connection test result.

400

Workspace ID is required.

404

Connection not found.

500

Internal server error

JSON

error
optional
string
details
optional
string
success
optional
boolean

Test an OAuth connection

curl --request POST \
  --url 'https://api.channelautomation.com/api/oauth/connections/<id>/test' \
  --header 'Authorization: Bearer <token>' \
  --header 'x-workspace-id: string'

const url = 'https://api.channelautomation.com/api/oauth/connections/<id>/test';
const options = {
  method: 'POST',
  headers: {'x-workspace-id': 'string', Authorization: 'Bearer <token>'}
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/oauth/connections/<id>/test"

headers = {
    "x-workspace-id": "string",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, headers=headers)

print(response.text)

Response example

{
  "error": "Internal server error",
  "details": "string",
  "success": false
}