Skip to main content
POST
Create Workflow Connection

Autorizaciones

Authorization
string
header
requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cuerpo

application/json

Create a piece connection. value shape depends on type.

piece_name
string
requerido

Piece identifier the connection is for, e.g. piece-slack.

display_name
string
requerido

Human label shown in the panel

type
enum<string>
requerido
Opciones disponibles:
OAUTH2,
PLATFORM_OAUTH2,
CLOUD_OAUTH2,
SECRET_TEXT,
BASIC_AUTH,
CUSTOM_AUTH,
NO_AUTH
value
Value · object

Type-specific credential fields (secret_text | username+password | props | OAuth2 fields). type is injected server-side.

Respuesta

Successful Response

A workflow piece connection (credential).

id
string
requerido

Referenced inside a step as {{connections['']}}

display_name
string
requerido
piece_name
string
requerido
status
string
requerido

ACTIVE | ERROR. A missing connection is absent from the response.