The ID of the integration the connection should be created for.
The name of the connection. This can be a human-readable name for the connection and can later be shown to the user. It is fine to allow the user to define the name of the connection.
The identitiy uuid is required when created by an environment (authentication via API Key). The identity must belong to the environment.
Fields required by the integration from step 1. The fields are different for each integration and provided as a key-value pair, using the field id as key and the user input as value.
Connection created response (step 1)
Fields for the seconds step (only provided when there is a second step for the integration).
The field type. It is used to render the correct input field in the frontend.
The id of the field. Represents the unique identifier of the field (like in HTML the name attribute).
The name of the field. Provided in different languages. If the requested language is not provided, use en as fallback.
Determines if the field is required or not.
Determines if the field is disabled or not.
Determines if the field is disabled on edit flow.
Icon to be shown in the input field.
The length of the field. It is used to validate the input.
The minimum length of the field.
The maximum length of the field.
The min and max dates for a date field. It is used to validate the input.
The minimum date of the field.
The maximum date of the field.
Determines if the field is a multiple field or not. If it is a multiple field, the user can select multiple values.
The suffix of the field. It is used to show additional information at the end of the input field.
The type of the banner. It is used to render a banner as field in the frontend.
The content of the banner. It is used to render a banner as field in the frontend.
Additional hint for the field. It is shown below the input field. The text is provided in different languages. If the requested language is not provided, use en as fallback. The string itself is markdown.
Determines if the banner should only be shown on edit page and not on create.
The options of the field. It is used to render a select field in the frontend. It is an array of objects where each object is one option.
The id of the option. It must be sent to the backend when the user selects the option as the value of the select field.
The name of the option. It can be provided as string or object including different languages. If the requested language is not provided, use en as fallback.
The selectable values of the textarea field. It is used to render selectable predefined options for users, to fill with a click into the textarea field.
The allowed file types for the file field. It is used to validate the file input.
The maximum file size in megabytes for the file field. It is used to validate the file input.
The international dialing code for the phone number field.
The placeholder of the field. It is used to show a hint in the input field.
The pattern of the field. It is used to validate the input with a regex pattern.
The default value of the field. It is used to prefill the input field.
The field depends on another field. It is used to show or hide the field based on the value of another field. The format is field_id:value or field_id1:value1|field_id2:value2 for multiple conditions (AND logic).
The field depends dynamically on another field. It is used to show or hide the field based on the value of another field. The format is field_id. The field will be shown if the other field has a value (not null or empty).
Determines if the field is an advanced field or not. Advanced fields are hidden by default and can be shown by the user.
Determines if the field should only be shown on the create page and not on edit.
Determines if the full path should be shown in the folder tree field.
Introductory text for the field. It is shown above the input field. The text is provided in different languages. If the requested language is not provided, use en as fallback. The string itself is markdown.
Additional wrapper attributes for the field. It can be used to add custom classes or styles to the field wrapper.
Determines if the field is sensitive or not. Sensitive fields are not logged in the backend.
The value of the field. It is used to prefill the input field. It can be a string or an integer.
Determines if the options should be loaded lazily or not. If true, the options will be loaded when the user opens the select field.
Determines if the folders should be sorted alphabetically or not. Only relevant for folder tree fields.
The step of the field. It is used to show fields in a stepped wizard. It is translated.
The number of rows for the textarea field.
The options of the folder tree field. When lazy loading is enabled it only provides the first folder level. More can be loaded with the more endpoint (/v1/connections/{uuid}/step2/{field_id}/more).
The label of the folder.
The id of the folder. It must be sent to the backend when the user selects the folder.
The children of the folder. If lazy loading is enabled, this will be null.
The label of the folder.
The id of the folder. It must be sent to the backend when the user selects the folder.
More children folders.
Determines if lazy loading is enabled. If yes, more data can be fetched with the more endpoint. Especially relevant for folder tree fields.
Additional helptexts for the integration. That help the user to understand what the integration is about. The text is provided in different languages. If the requested language is not provided, use 'en' as fallback. The string itself is markdown.
The error response is returned when the client is not authenticated. The client must provide a valid authentication key to access the resource.
The error code is a machine readable code describing the error.
The error message is a human readable message describing the error. It is mainly used for understanding the error by developers. It is not meant to be shown to real users.
For many errors we provide suggestions how you can resolve the error on your own.
The trace ID is a unique identifier for the request. It is used to trace the request through the system. Please provide the trace_id when reporting an error to our support team.
This parameter provides a way to contact support. It is mainly used for developers. It is not meant to be shown to real users.
The error response is returned when the user is not authorized to perform the action. The user might not have the necessary permissions or the action is not allowed in the current state of the system.
The error code is a machine readable code describing the error.
The error message is a human readable message describing the error. It is mainly used for understanding the error by developers. It is not meant to be shown to real users.
For many errors we provide suggestions how you can resolve the error on your own.
The trace ID is a unique identifier for the request. It is used to trace the request through the system. Please provide the trace_id when reporting an error to our support team.
This parameter provides a way to contact support. It is mainly used for developers. It is not meant to be shown to real users.
The error response is returned when the client has provided invalid data in the request.
The error code is a machine readable code describing the error.
The error message is a human readable message describing the error. It is mainly used for understanding the error by developers. It is not meant to be shown to real users.
For many errors we provide suggestions how you can resolve the error on your own.
The trace ID is a unique identifier for the request. It is used to trace the request through the system. Please provide the trace_id when reporting an error to our support team.
The errors object contains a list of fields with their corresponding error messages.
This parameter provides a way to contact support. It is mainly used for developers. It is not meant to be shown to real users.
The error response is returned when an unknown server error occurred. Unfortunately, there is nothing you can do to resolve the error on your own. Please try again later or contact support and provide the trace_id.
The error code is a machine readable code describing the error.
The error message is a human readable message describing the error. It is mainly used for understanding the error by developers. It is not meant to be shown to real users.
For many errors we provide suggestions how you can resolve the error on your own.
The trace ID is a unique identifier for the request. It is used to trace the request through the system. Please provide the trace_id when reporting an error to our support team.
This parameter provides a way to contact support. It is mainly used for developers. It is not meant to be shown to real users.