RevKeenDocs
StatusSupport
API Reference

Get integration status

Return the current configuration snapshot for a provider — activation state, last sync timestamp, next scheduled sync, sync interval, auto-send setting, invoice lookback window, and circuit-breaker error count. Does not trigger a sync or a credential test; use `/sync` or `/test` for those. --- **Related endpoints** - `POST /integrations/{provider}/activate` — Activate integration - `POST /integrations/{provider}/deactivate` — Deactivate integration - `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 - `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.

GET
/integrations/{provider}

Return the current configuration snapshot for a provider — activation state, last sync timestamp, next scheduled sync, sync interval, auto-send setting, invoice lookback window, and circuit-breaker error count. Does not trigger a sync or a credential test; use /sync or /test for those.

Related endpoints

  • POST /integrations/{provider}/activate — Activate integration
  • POST /integrations/{provider}/deactivate — Deactivate integration
  • 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
  • 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.

Authorization

x-api-key<token>

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

provider*string

External system provider (practicehub, teamup, wodify, terminal, hubspot, slack, linear).

Value in

  • "practicehub"
  • "teamup"
  • "wodify"
  • "terminal"
  • "hubspot"
  • "slack"
  • "linear"

Response Body

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl "https://api.revkeen.com/v2/integrations/practicehub" \
  -H "x-api-key: $REVKEEN_API_KEY"
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "provider": "practicehub",    "is_active": true,    "sync_enabled": true,    "status": "connected",    "last_sync_at": "2019-08-24T14:15:22Z",    "last_sync_error": "string",    "sync_health": "healthy",    "provider_state": {      "consecutive_errors": 0,      "last_error_at": "2019-08-24T14:15:22Z",      "last_sync_at": "2019-08-24T14:15:22Z",      "mode": "string"    },    "sync_interval": {      "has_repeatable_job": true,      "interval_ms": 0,      "next_run": "2019-08-24T14:15:22Z"    },    "configuration": {      "property1": null,      "property2": null    },    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  }}

Deactivate integration POST

Deactivate an active integration. Cancels in-flight sync jobs, clears scheduled cron entries, and purges stored credentials via KMS. Historical sync logs, product mappings, and payment-method mappings are retained so re-activation preserves the mapping set. Returns `404` if no active integration exists for the provider. --- **Related endpoints** - `POST /integrations/{provider}/activate` — Activate 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 - `GET /integrations` — List all integrations **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).

Update invoice lookback period PUT

Set how many days of historical invoices are fetched on the first (full) sync. Applies only to the initial bootstrap — subsequent incremental syncs use the per-resource cursor regardless of this value. Typical range 30–365 days. --- **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).