Test integration credentials
Validate credentials against the provider's authentication endpoint without activating the integration. Used by the activation wizard to surface credential errors before the merchant commits to a sync schedule. Returns `{ valid: true }` on success or `{ valid: false, reason }` with the provider's error message on failure. No state is persisted. --- **Related endpoints** - `POST /integrations/{provider}/activate` — Activate integration - `POST /integrations/{provider}/deactivate` — Deactivate integration - `GET /integrations/{provider}` — Get integration status - `POST /integrations/{provider}/rotate` — Rotate integration credentials - `POST /integrations/{provider}/sync` — Trigger manual sync - `POST /integrations/{provider}/invoices/{externalInvoiceId}/refresh` — Refresh a single PracticeHub invoice - `GET /integrations/{provider}/invoices/{externalInvoiceId}/refresh-status` — Get demand invoice refresh status - `GET /integrations` — List all integrations **Common errors** - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
Validate credentials against the provider's authentication endpoint without activating the integration. Used by the activation wizard to surface credential errors before the merchant commits to a sync schedule. Returns { valid: true } on success or { valid: false, reason } with the provider's error message on failure. No state is persisted.
Related endpoints
POST /integrations/{provider}/activate— Activate integrationPOST /integrations/{provider}/deactivate— Deactivate integrationGET /integrations/{provider}— Get integration statusPOST /integrations/{provider}/rotate— Rotate integration credentialsPOST /integrations/{provider}/sync— Trigger manual syncPOST /integrations/{provider}/invoices/{externalInvoiceId}/refresh— Refresh a single PracticeHub invoiceGET /integrations/{provider}/invoices/{externalInvoiceId}/refresh-status— Get demand invoice refresh statusGET /integrations— List all integrations
Common errors
401 authentication_error— missing, invalid, expired, or revoked credential. Codes:authentication_failed,invalid_api_key,expired_api_key,api_key_revoked,session_invalid,merchant_required. Carries aWWW-Authenticate: Bearerchallenge.
Idempotency
Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.
Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.
In: header
Path Parameters
Providers that can be activated or tested. TeamUp uses Connection Manager M2M tokens (Lane B); PracticeHub and Wodify use API keys.
Value in
- "practicehub"
- "wodify"
- "terminal"
- "teamup"
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://api.revkeen.com/v2/integrations/practicehub/test" \
-H "x-api-key: $REVKEEN_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"credentials": {
"apiKey": "string",
"baseUrl": "https://example.com",
"appName": "RevKeen",
"appEmail": "info@revkeen.com"
}
}'{ "valid": true, "error": "string"}Toggle integration sync PUT
Enable or disable automatic sync for an integration without destroying stored credentials or mappings. Disabled integrations are skipped by the sync cron until re-enabled. Useful for temporary pauses during merchant off-boarding or provider-side maintenance windows. --- **Related endpoints** - `POST /integrations/{provider}/activate` — Activate integration - `POST /integrations/{provider}/deactivate` — Deactivate integration - `GET /integrations/{provider}` — Get integration status - `POST /integrations/{provider}/test` — Test integration credentials - `POST /integrations/{provider}/rotate` — Rotate integration credentials - `POST /integrations/{provider}/sync` — Trigger manual sync - `POST /integrations/{provider}/invoices/{externalInvoiceId}/refresh` — Refresh a single PracticeHub invoice - `GET /integrations/{provider}/invoices/{externalInvoiceId}/refresh-status` — Get demand invoice refresh status **Common errors** - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).
Trigger manual sync POST
Enqueue an immediate sync job for an already-active integration. By default only records modified since the last cursor are processed; pass `fullResync=true` to ignore the cursor and re-process every record — safe but expensive, useful after a schema change or to recover from drift. Returns `400` if the integration is not active. --- **Related endpoints** - `POST /integrations/{provider}/activate` — Activate integration - `POST /integrations/{provider}/deactivate` — Deactivate integration - `GET /integrations/{provider}` — Get integration status - `POST /integrations/{provider}/test` — Test integration credentials - `POST /integrations/{provider}/rotate` — Rotate integration credentials - `POST /integrations/{provider}/invoices/{externalInvoiceId}/refresh` — Refresh a single PracticeHub invoice - `GET /integrations/{provider}/invoices/{externalInvoiceId}/refresh-status` — Get demand invoice refresh status - `GET /integrations` — List all integrations **Common errors** - `400 invalid_request` — malformed payload or failed validation. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).