Run a single check on a connection | Comp AI API

Run a single check on a connection in Comp AI. Connect vendor systems, configure OAuth apps, run compliance checks, sync employees, manage variables.

POST /v1/integrations/checks/connections/{connectionId}/run/{checkId}

Run a single check on a connection

cURL

curl --request POST \
  --url https://api.trycomp.ai/v1/integrations/checks/connections/{connectionId}/run/{checkId} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.trycomp.ai/v1/integrations/checks/connections/{connectionId}/run/{checkId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.trycomp.ai/v1/integrations/checks/connections/{connectionId}/run/{checkId}"

headers = {"X-API-Key": "<api-key>"}

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

print(response.text)

Authorizations

X-API-Key · string · header · required

API key for authentication

Path Parameters

connectionId · string · required

checkId · string · required

Response

201 - undefined