Developer APIResourcesCustom connectors

Create Custom Connector

The Create operation allows you to create a custom connector in your workspace.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
titlestringRequired
The title of the custom connector you plan to create.
descriptionstringRequired
A description of your custom connector. This is visible when you share your custom connector through a private link or the community library. Markdown is allowed.
codestringRequired
The Ruby code for your custom connector. Ensure that the code is stringified. Your code cannot exceed 10MB in size.
notestringOptional
Notes for the initial version of your custom connector.

Response

Success - The custom connector was created successfully.

idinteger or null
The unique identifier of the created custom connector.
namestring or null
The internal name of the custom connector.
titlestring or null
The title of the created custom connector.
latest_versioninteger or null
The most recent version of the custom connector.
latest_version_notestring or null
Notes associated with the latest version of the custom connector.
latest_released_versioninteger or null
The most recent released version of the custom connector.
latest_released_version_notestring or null
Notes associated with the latest released version of the custom connector.
latest_shared_versioninteger or null
The most recent shared version of the custom connector.
latest_shared_version_notestring or null
Notes associated with the latest shared version of the custom connector.
oem_shared_versioninteger or null
The shared version of the custom connector for OEM accounts.
oem_shared_atdatetime or null
Timestamp indicating when the connector was shared with OEM accounts.
released_versionslist of objects or null
List of released versions for the custom connector.

Errors