Test an integration

Call the vendor with the stored credential and record the answer on the connection: connected when it worked, degraded with the reason when it did not. Never returns the credential.

POSThttps://app.trygtm.com/api/v1/integrations/{provider}/test
Scope
write

Path parameters

providerstringrequired
Which connection to test, by provider id from list_integrations.google_calendarcalendlycal_comhubspotpipedriveattiosalesforcezohogohighlevelslackzapierwebhook

Headers

Idempotency-Keystringoptional
A key unique to this write, up to 255 characters. A retry carrying the same key returns the first response instead of running again. Kept for 24 hours.

Request

curl -X POST https://app.trygtm.com/api/v1/integrations/google_calendar/test \
  -H "Authorization: Bearer $TRYGTM_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Response

{
  "data": {
    "ok": true,
    "label": "Acme Dental"
  }
}

Was this page helpful?