Skip to main content
PUT
Connect

Authorizations

korve.session_token
string
cookie
required

Path Parameters

orgId
string
required

The organization's id (UUID) or slug — either form is accepted.

projectId
string
required

The project's id (UUID) or slug — either form is accepted.

Query Parameters

environment
string

Environment slug. Defaults to "production"; unknown environment slugs return 404.

Pattern: ^[a-z][a-z0-9-]{0,38}$

Body

application/json
secretKey
string
required
Required string length: 16 - 512
webhookSecret
string
required
Required string length: 16 - 512
credentialScopes
enum<string>[]
required

Exact Korve operation allowlist. These values constrain Korve and are not self-attested processor permission claims.

Required array length: 5 elements
Available options:
customers:write,
products:write,
prices:write,
checkout_sessions:write,
subscriptions:write
allowedRedirectOrigins
string<uri>[]
required
Required array length: 1 - 25 elements
Maximum string length: 2048

Response

Connected configuration.

status
enum<string>
required
Available options:
not_configured,
ready,
disabled
credentialConfigured
boolean
required
credentialHint
string | null
required
webhookUrl
string<uri> | null
required
webhookSecretConfigured
boolean
required
credentialScopes
string[]
required

Korve-side operation allowlist. This does not claim or replace the connected processor's credential permissions.

allowedRedirectOrigins
string<uri>[]
required
connectedAt
string<date-time> | null
required
updatedAt
string<date-time> | null
required