Activepieces Management Octri Preview
POST/v1/global-connections

Create a global connection

Creates a global connection for the supplied piece and projects. Choose a supported connection type and provide its matching value object; the schema includes secret text, OAuth 2.0, and cloud OAuth 2.0 configurations.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

10 body fields

Global connection details. The required fields depend on the connection type.

displayNamestringrequired
externalIdstringoptional
metadataobjectoptional
pieceNamestringrequired
pieceVersionstringoptional
preSelectForNewProjectsbooleanoptional
projectIdsarray<string>required
scopestringrequired
Allowed:PLATFORM
typestringrequired
Allowed:SECRET_TEXT
valueobjectrequired

1 status code
201Returns the created global connection, including its identifier, display name, piece, associated projects, scope, status, and timestamps.
createdstringrequired
displayNamestringrequired
externalIdstringrequired
flowIdsarray<string>optional
idstringrequired
metadataobjectoptional
ownerobjectoptional
ownerIdstringoptional
pieceNamestringrequired
pieceVersionstringrequired
platformIdstringoptional
preSelectForNewProjectsbooleanrequired
projectIdsarray<string>required
scopestringrequired
Allowed:PROJECTPLATFORM
statusstringrequired
Allowed:ACTIVEMISSINGERROR
typestringrequired
Allowed:OAUTH2PLATFORM_OAUTH2CLOUD_OAUTH2SECRET_TEXTBASIC_AUTHCUSTOM_AUTHNO_AUTH
updatedstringrequired
usingSecretManagerbooleanrequired

Error handling

Provide displayName, pieceName, type, value, scope, and projectIds. The visible connection variants require scope to be PLATFORM; for SECRET_TEXT, value requires type and secret_text, while OAUTH2 requires client_id, code, scope, client_secret, redirect_url, and type.