RevKeen Docs
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}/sync — Trigger manual sync
  • GET /integrations — List all integrations
  • PUT /integrations/{provider}/status — Update integration status
  • PUT /integrations/{provider}/sync-toggle — Toggle integration sync
  • PUT /integrations/{provider}/sync-interval — Update sync interval

Common errors

  • 401 unauthenticated — missing, malformed, or revoked API key.
GET
/integrations/{provider}
x-api-key<token>

Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.

In: header

Path Parameters

provider*string
Value in"practicehub" | "wodify" | "terminal"

Response Body

application/json

application/json

application/json

curl "https://api.revkeen.com/v2/integrations/practicehub" \  -H "x-api-key: $REVKEEN_API_KEY"
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "provider": "practicehub",
    "isActive": true,
    "syncEnabled": true,
    "status": "connected",
    "lastSyncAt": "2019-08-24T14:15:22Z",
    "lastSyncError": "string",
    "syncHealth": "healthy",
    "providerState": {
      "consecutiveErrors": 0,
      "lastErrorAt": "string",
      "lastSyncAt": "string",
      "mode": "string"
    },
    "syncInterval": {
      "hasRepeatableJob": true,
      "intervalMs": 0,
      "nextRun": "2019-08-24T14:15:22Z"
    },
    "configuration": {
      "property1": null,
      "property2": null
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
{
  "error": "string"
}
{
  "error": "string"
}