Activepieces Management Octri Preview
POST/v1/app-connections

Create or update an app connection

Creates or updates an app connection based on the app name. When you provide a body, identify the connection with externalId, displayName, pieceName, and projectId, and supply credentials that match the selected connection type.

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

8 body fields

App connection details used to create or update a connection. The body is optional; when supplied, externalId, displayName, pieceName, projectId, type, and value are required.

displayNamestringrequired
externalIdstringrequired
metadataobjectoptional
pieceNamestringrequired
pieceVersionstringoptional
projectIdstringrequired
typestringrequired
Allowed:SECRET_TEXT
valueobjectrequired

1 status code
200Returns the result of creating or updating the app connection.

Error handling

When a request body is supplied, externalId, displayName, pieceName, projectId, type, and value are required. The credential fields in value must match the selected type; for example, SECRET_TEXT requires secret_text, while OAUTH2 requires client_id, code, scope, client_secret, redirect_url, and type.