Skip to content

integrations reference

This reference follows the current server implementation. Use the SDK for customer flows; it manages identity proof and retries. Authentication and errors apply to every endpoint. Types below describe JSON: dates are ISO strings, ? means optional, and null differs from an omitted field. Responses may include additional fields. Schemas also enforce constraints that TypeScript cannot express; download the request JSON Schemas. Named response types are defined in the data model reference.

GET /v1/integrations/:provider/runtime-config

Section titled “GET /v1/integrations/:provider/runtime-config”

Authentication: Secret app API key; customer/session proof is still required wherever the operation acts on an identity.

Path parameters: provider (string). Every target must belong to the authenticated app or workspace.

Supply these values as query parameters. Path parameters remain in the URL.

"stripe" | "apple_app_store" | "google_play" | "google" | "apple" | "microsoft" | "github" | "apns" | "fcm" | "cloudflare_email"
JSON response shape
{ error: string;
message: string;
}
JSON response shape
{ provider: "stripe" | "apple_app_store" | "google_play" | "google" | "apple" | "microsoft" | "github" | "apns" | "fcm" | "cloudflare_email" | "apple_app_store_connect";
status: "active";
publicConfig: IntegrationPublicConfig;
secrets: Record<string, string>;
}

Errors: validation/authentication failures use the common error envelope. A missing or inaccessible target returns an error; never interpret it as an empty successful result.

Implementation · Handler: inline route handler.