Skip to content
/
Personal Connector Config...
Last updated

Personal Connector Configuration Object

Represents a user-specific configuration for a personal connector. Configurations store connector settings, credentials, and access permissions, enabling users to connect their personal accounts to external services.

Properties

id string

Unique identifier for the configuration. Format: pconf_ followed by alphanumeric characters.

object string

Object type identifier. Always personal_connector.configuration.

user_id string optional

User ID who owns this configuration. Either user_id or api_key_id must be present.

api_key_id string optional

API key ID associated with this configuration. Either user_id or api_key_id must be present.

organization_id string

Organization ID this configuration belongs to.

personal_connector_id string

Reference to the personal connector definition. Links to a Personal Connector Object.

name string

User-friendly name for this configuration. Example: "My GitHub Account", "Work ClickUp".

configuration object

Connector-specific configuration settings. Structure varies by connector type.

Show example configurations by connector type

GitHub Configuration:

{
  "repository": "acme/backend",
  "branch": "main",
  "paths": ["src/", "docs/"]
}

ClickUp Configuration:

{
  "workspace_id": "12345",
  "list_id": "67890",
  "default_priority": 3
}

Jira Configuration:

{
  "project_key": "PROJ",
  "issue_type": "Task",
  "default_assignee": "user@example.com"
}

Teams Configuration:

{
  "team_id": "team-abc123",
  "channel_id": "channel-xyz789"
}

Custom MCP Configuration:

{
  "endpoint": "https://my-server.com/api",
  "custom_settings": {...}
}

credentials object optional

Encrypted authentication credentials. Structure varies by authentication method. Note: Credentials are encrypted at rest and never returned in API responses.

Show credential formats by auth method

API Key:

{
  "type": "api_key",
  "api_key": "encrypted_value"
}

OAuth2:

{
  "type": "oauth2",
  "access_token": "encrypted_value",
  "refresh_token": "encrypted_value",
  "expires_at": "2025-12-31T23:59:59Z"
}

Bearer Token:

{
  "type": "bearer",
  "token": "encrypted_value"
}

enabled boolean

Whether this configuration is currently active. Defaults to true.

health_status string

Current health status of the connector. Values:

  • healthy - Connection is working
  • unhealthy - Connection failed or credentials invalid
  • unknown - Not yet tested

last_sync_at string optional

ISO 8601 timestamp of the last successful tool discovery or health check.

last_error string optional

Last error message if the connector is unhealthy.

description string optional

Optional description explaining the configuration's purpose.

metadata object optional

Custom key-value pairs for tagging and filtering configurations.

created_at string

ISO 8601 timestamp when the configuration was created.

updated_at string

ISO 8601 timestamp when the configuration was last updated.

Previous page
Next page