Integrations Data Structures

All data structures used in the Integrations API endpoint.

View API:Integrations API

Integration Action Result

Result of an integration action (add, remove, etc.)

Integration Action Result

object

Result of an integration action (add, remove, etc.)

okbooleanrequired

Whether the action was successful

messagestring

Optional message describing the result or error

Example: "Integration added successfully"

Integration Provider

Integration provider identifier

Integration Provider

string

Integration provider identifier

revenuecatstripeapp_store_connectshopifygoogle_play_consolewhoppaddlewoocommercesuperwall

Integration Status

Integration connection status

Integration Status

string

Integration connection status

connectednot_connectedinactive

Workspace Integration

A workspace integration configuration

Workspace Integration

object

A workspace integration configuration

idstringrequired

Unique integration identifier

workspaceIdstringrequired

Workspace identifier this integration belongs to

providerIntegrationProviderrequired

Integration provider type

statusIntegrationStatusrequired

Current status of the integration

credentialsEncryptedstring | null

Encrypted credentials for the integration (base64 iv+ciphertext). Never exposed in API responses for security.

dataLastReceivedAtstring (date-time) | null

ISO 8601 timestamp of when data was last received from this integration

createdAtstring (date-time)required

ISO 8601 timestamp of when the integration was created

updatedAtstring (date-time)required

ISO 8601 timestamp of when the integration was last updated

interface IntegrationActionResult {
  /** Whether the action was successful */
  ok: boolean;
  /** Optional message describing the result or error */
  message?: string;
}

type IntegrationProvider = "revenuecat" | "stripe" | "app_store_connect" | "shopify" | "google_play_console" | "whop" | "paddle" | "woocommerce" | "superwall";

type IntegrationStatus = "connected" | "not_connected" | "inactive";

interface WorkspaceIntegration {
  /** Unique integration identifier */
  id: string;
  /** Workspace identifier this integration belongs to */
  workspaceId: string;
  /** Integration provider type */
  provider: IntegrationProvider;
  /** Current status of the integration */
  status: IntegrationStatus;
  /** Encrypted credentials for the integration (base64 iv+ciphertext). Never exposed in API responses for security. */
  credentialsEncrypted?: string;
  /** ISO 8601 timestamp of when data was last received from this integration */
  dataLastReceivedAt?: string;
  /** ISO 8601 timestamp of when the integration was created */
  createdAt: string;
  /** ISO 8601 timestamp of when the integration was last updated */
  updatedAt: string;
}

interface IntegrationActionResult {
  /** Whether the action was successful */
  ok: boolean;
  /** Optional message describing the result or error */
  message?: string;
}

type IntegrationProvider = "revenuecat" | "stripe" | "app_store_connect" | "shopify" | "google_play_console" | "whop" | "paddle" | "woocommerce" | "superwall";

type IntegrationStatus = "connected" | "not_connected" | "inactive";

interface WorkspaceIntegration {
  /** Unique integration identifier */
  id: string;
  /** Workspace identifier this integration belongs to */
  workspaceId: string;
  /** Integration provider type */
  provider: IntegrationProvider;
  /** Current status of the integration */
  status: IntegrationStatus;
  /** Encrypted credentials for the integration (base64 iv+ciphertext). Never exposed in API responses for security. */
  credentialsEncrypted?: string;
  /** ISO 8601 timestamp of when data was last received from this integration */
  dataLastReceivedAt?: string;
  /** ISO 8601 timestamp of when the integration was created */
  createdAt: string;
  /** ISO 8601 timestamp of when the integration was last updated */
  updatedAt: string;
}