Test app auth

Check an integration app's credentials with a cheap authenticated read against the vendor.

POSThttps://api.tried.com.au/test-app-auth/{id}

Needs keys A live check needs the vendor's API key or token on the app. In mock mode it always succeeds with mock: true.

Makes one read-only call to the vendor with the app's credentials and updates the app's status. Cal.com reads /me, Calendly /users/me, Zendesk /api/v2/users/me.json, and the CRM types run the same check as Test CRM auth. OAuth tokens close to expiry are refreshed first.

Request#

Path parameter	Type	Required	Description
`id`	string	Yes	The `app_id`.

This endpoint takes no body.

Example request#

curl -X POST https://api.tried.com.au/test-app-auth/app_6f1c2a9e4b7d3058a1e2c4f9 \
  -H "Authorization: Bearer $TRIED_API_KEY"

const res = await fetch("https://api.tried.com.au/test-app-auth/app_6f1c2a9e4b7d3058a1e2c4f9", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const result = await res.json();

import os, requests

res = requests.post(
    "https://api.tried.com.au/test-app-auth/app_6f1c2a9e4b7d3058a1e2c4f9",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)
result = res.json()

Response#

200 OK, also when the vendor rejects the credentials. Check ok.

{ "ok": true, "mock": false, "message": "Authenticated." }

In mock mode:

{ "ok": true, "mock": true, "message": "Mock mode: no credentials are set, actions return sample data." }

Field	Type	Description
`ok`	boolean	`true` when the vendor accepted the credentials. A live success sets the app's `status` to `connected`, a failure sets it to `error`.
`mock`	boolean	`true` when no live call was made.
`message`	string	`Authenticated.`, the mock notice, or the vendor error, for example `GET /v2/me returned 401: {...}`.

Errors#

Status	When
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request. This route needs the `admin` scope. Dashboard members are read-only.
`404`	`App <id> not found` in this workspace.
`429`	Rate limit exceeded. See Rate limits.

See Errors for the body format.

Retell compatibility#

Same path and method as Retell. Retell returns { "success": boolean }. Tried returns ok, mock and message.