Create Connectors

Create a new connector

curl --request POST \
  --url https://api.wellapp.ai/v1/connectors \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "connector",
  "attributes": {
    "slug": "salesforce",
    "name": "Salesforce",
    "description": "Connects to Salesforce CRM for sync.",
    "category": "api",
    "direction": "import",
    "tags": [
      "crm",
      "cloud",
      "sync"
    ],
    "version": "2.1.0",
    "data_quality": {
      "imported_fields": [
        "invoice",
        "company",
        "people"
      ],
      "last_synced": "2025-06-20T09:00:00Z"
    },
    "redirect_url": "https://app.well.com/connectors/salesforce/success",
    "state": "active"
  },
  "relationships": {
    "published_by": {
      "data": {
        "type": "workspace",
        "id": "airbyte"
      }
    },
    "logo": {
      "data": {
        "type": "media",
        "id": "media3"
      }
    }
  },
  "included": [
    {
      "type": "workspace",
      "id": "airbyte",
      "attributes": {
        "name": "Airbyte",
        "description": "Open-source data integration platform",
        "website": "https://airbyte.com",
        "external_workspace_id": "airbyte_workspace_001"
      }
    },
    {
      "type": "media",
      "id": "media3",
      "attributes": {
        "file_name": "salesforce_logo.png",
        "content_type": "image/png",
        "file_size": 15420,
        "media_type": "logo",
        "upload_url": "https://storage.well.com/media/salesforce_logo.png"
      }
    }
  ]
}
'

{
  "data": {
    "type": "connector",
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "attributes": {
      "slug": "salesforce",
      "name": "Salesforce",
      "description": "Connects to Salesforce CRM for sync.",
      "category": "api",
      "direction": "import",
      "tags": [
        "crm",
        "cloud",
        "sync"
      ],
      "status": "active",
      "data_quality": {
        "imported_fields": [
          "invoice",
          "company",
          "people"
        ],
        "last_synced": "2025-06-20T09:00:00Z"
      },
      "redirect_url": "https://app.well.com/connectors/salesforce/success",
      "state": "active",
      "created_at": "2025-10-07T14:30:00.000Z",
      "updated_at": "2025-10-07T14:30:00.000Z"
    },
    "relationships": {
      "published_by": {
        "data": {
          "type": "workspace",
          "id": "airbyte"
        }
      },
      "logo": {
        "data": {
          "type": "media",
          "id": "550e8400-e29b-41d4-a716-446655440010"
        }
      }
    }
  },
  "included": [
    {
      "type": "workspace",
      "id": "airbyte",
      "attributes": {
        "name": "Airbyte",
        "description": "Open-source data integration platform",
        "website": "https://airbyte.com"
      }
    },
    {
      "type": "media",
      "id": "550e8400-e29b-41d4-a716-446655440010",
      "attributes": {
        "file_name": "salesforce_logo.png",
        "content_type": "image/png",
        "file_size": 12345
      }
    }
  ]
}

POST

connectors

Create a new connector

curl --request POST \
  --url https://api.wellapp.ai/v1/connectors \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "connector",
  "attributes": {
    "slug": "salesforce",
    "name": "Salesforce",
    "description": "Connects to Salesforce CRM for sync.",
    "category": "api",
    "direction": "import",
    "tags": [
      "crm",
      "cloud",
      "sync"
    ],
    "version": "2.1.0",
    "data_quality": {
      "imported_fields": [
        "invoice",
        "company",
        "people"
      ],
      "last_synced": "2025-06-20T09:00:00Z"
    },
    "redirect_url": "https://app.well.com/connectors/salesforce/success",
    "state": "active"
  },
  "relationships": {
    "published_by": {
      "data": {
        "type": "workspace",
        "id": "airbyte"
      }
    },
    "logo": {
      "data": {
        "type": "media",
        "id": "media3"
      }
    }
  },
  "included": [
    {
      "type": "workspace",
      "id": "airbyte",
      "attributes": {
        "name": "Airbyte",
        "description": "Open-source data integration platform",
        "website": "https://airbyte.com",
        "external_workspace_id": "airbyte_workspace_001"
      }
    },
    {
      "type": "media",
      "id": "media3",
      "attributes": {
        "file_name": "salesforce_logo.png",
        "content_type": "image/png",
        "file_size": 15420,
        "media_type": "logo",
        "upload_url": "https://storage.well.com/media/salesforce_logo.png"
      }
    }
  ]
}
'

{
  "data": {
    "type": "connector",
    "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "attributes": {
      "slug": "salesforce",
      "name": "Salesforce",
      "description": "Connects to Salesforce CRM for sync.",
      "category": "api",
      "direction": "import",
      "tags": [
        "crm",
        "cloud",
        "sync"
      ],
      "status": "active",
      "data_quality": {
        "imported_fields": [
          "invoice",
          "company",
          "people"
        ],
        "last_synced": "2025-06-20T09:00:00Z"
      },
      "redirect_url": "https://app.well.com/connectors/salesforce/success",
      "state": "active",
      "created_at": "2025-10-07T14:30:00.000Z",
      "updated_at": "2025-10-07T14:30:00.000Z"
    },
    "relationships": {
      "published_by": {
        "data": {
          "type": "workspace",
          "id": "airbyte"
        }
      },
      "logo": {
        "data": {
          "type": "media",
          "id": "550e8400-e29b-41d4-a716-446655440010"
        }
      }
    }
  },
  "included": [
    {
      "type": "workspace",
      "id": "airbyte",
      "attributes": {
        "name": "Airbyte",
        "description": "Open-source data integration platform",
        "website": "https://airbyte.com"
      }
    },
    {
      "type": "media",
      "id": "550e8400-e29b-41d4-a716-446655440010",
      "attributes": {
        "file_name": "salesforce_logo.png",
        "content_type": "image/png",
        "file_size": 12345
      }
    }
  ]
}

Headers

Authorization

string

required

Bearer token for authentication

Body

application/json

data

object

required

Show child attributes

data.type

string

required

Resource type identifier

Allowed value: "connector"

data.attributes

object

required

Show child attributes

data.attributes.slug

string

required

Connector slug used in URLs (system generated if not provided)

Maximum string length: 255

Example:

"salesforce"

data.attributes.name

string

required

Connector name

Maximum string length: 255

Example:

"Salesforce"

data.attributes.description

string

required

Description of the connector

Maximum string length: 1000

Example:

"Connects to Salesforce CRM for sync."

data.attributes.category

enum<string>

required

Category type. See all available categories for complete list.

Available options:

database,

data_warehouse,

file,

...

Example:

"api"

data.attributes.direction

enum<string>

required

Data flow direction capability

Available options:

import,

export

Example:

"import"

data.attributes.tags

string[]

Grouping/search tags

Example:

["crm", "cloud", "sync"]

data.attributes.version

string

Connector version

Example:

"2.1.0"

data.attributes.data_quality

object

Show child attributes

data.attributes.data_quality.imported_fields

enum<string>[]

Category connector. See all available categories for complete list.

Available options:

invoice,

company,

people,

...

Example:

["invoice", "company", "people"]

data.attributes.data_quality.last_synced

string<date-time>

Timestamp of last sync

Example:

"2025-06-20T09:00:00Z"

data.attributes.redirect_url

string<uri>

URL to redirect customers after onboarding flow

Example:

"https://app.well.com/connectors/salesforce/success"

data.attributes.state

string

State included in the redirect URL

Example:

"active"

data.relationships

object

Show child attributes

data.relationships.published_by

object

Show child attributes

data.relationships.published_by.data

object

Show child attributes

data.relationships.published_by.data.type

string

required

Allowed value: "workspace"

data.relationships.published_by.data.id

string

required

UUID of an existing workspace or temp-id that references a workspace defined in the included array

Example:

"airbyte"

data.relationships.logo

object

Show child attributes

data.relationships.logo.data

object

Show child attributes

data.relationships.logo.data.type

string

required

Allowed value: "media"

data.relationships.logo.data.id

string

required

UUID of an existing logo or temp-id that references a logo defined in the included array

Example:

"media3"

data.included

object

Show child attributes

data.included.published_by

object

Workspaces associated with this company

Show child attributes

data.included.published_by.data

object[]

Show child attributes

data.included.published_by.data.type

string

required

Allowed value: "workspace"

data.included.published_by.data.id

string<uuid>

required

Temp-id that references to the publisher defined in the included array

data.included.published_by.data.attributes

object

required

Show child attributes

data.included.published_by.data.attributes.name

string

required

Workspace name

Required string length: 1 - 255

data.included.published_by.data.attributes.description

string

Workspace description

Maximum string length: 1000

data.included.published_by.data.attributes.avatar_color

string

Avatar color in hexadecimal format (e.g., #FF5733)

data.included.published_by.data.attributes.external_workspace_id

string

External workspace identifier

Required string length: 1 - 255

data.included.logo

object

Media files associated with this company

Show child attributes

data.included.logo.data

object[]

Show child attributes

data.included.logo.data.type

string

required

Allowed value: "media"

data.included.logo.data.id

string<uuid>

required

Temp-id that references to the logo defined in the included array

data.included.logo.data.attributes

object

required

Show child attributes

data.included.logo.data.attributes.media_type

enum<string>

required

Type of media (avatar, logo, banner) See Media type documentation for complete list.

Available options:

avatar,

logo,

banner

data.included.logo.data.attributes.url

string<uri>

required

Direct media URL

data.included.logo.data.attributes.is_primary

boolean

default:true

Marks preferred media. Default: true

Response

Connector created successfully

data

object

Show child attributes

data.type

string

Allowed value: "connector"

data.id

string<uuid>

UUID of the created connector

Example:

"550e8400-e29b-41d4-a716-446655440000"

data.attributes

object

Show child attributes

data.attributes.slug

string

Connector slug used in URLs (system generated if not provided)

Maximum string length: 255

Example:

"salesforce"

data.attributes.name

string

Connector name

Maximum string length: 255

Example:

"Salesforce"

data.attributes.description

string

Description of the connector

Maximum string length: 1000

Example:

"Connects to Salesforce CRM for sync."

data.attributes.category

enum<string>

Integration category. See all available categories for complete list.

Available options:

database,

...

Example:

"api"

data.attributes.direction

enum<string>

Data flow direction capability

Available options:

import,

export,

both

Example:

"import"

data.attributes.tags

string[]

Grouping/search tags

Example:

["crm", "cloud", "sync"]

data.attributes.data_quality

object

Show child attributes

data.attributes.data_quality.imported_fields

enum<string>[]

Category connector. See all available categories for complete list.

Available options:

invoice,

company,

people

Example:

["invoice", "company", "people"]

data.attributes.data_quality.last_synced

string<date-time>

Timestamp of last sync

Example:

"2025-06-20T09:00:00Z"

data.attributes.redirect_url

string<uri>

URL to redirect customers after onboarding flow

Example:

"https://app.well.com/connectors/salesforce/success"

data.attributes.state

string

State included in the redirect URL

Example:

"active"

data.attributes.status

enum<string>

Lifecycle status (system managed)

Available options:

active,

beta,

deprecated

Example:

"active"

data.attributes.created_at

string<date-time>

Creation timestamp

Example:

"2025-10-07T14:30:00.000Z"

data.attributes.updated_at

string<date-time>

Last update timestamp

Example:

"2025-10-07T14:30:00.000Z"

data.relationships

object

Show child attributes

data.relationships.published_by

object

Show child attributes

data.relationships.published_by.data

object

Show child attributes

data.relationships.published_by.data.type

string

Allowed value: "workspace"

data.relationships.published_by.data.id

string<uuid>

UUID of the workspace that published this connector

Example:

"550e8400-e29b-41d4-a716-446655440001"

data.relationships.logo

object

Show child attributes

data.relationships.logo.data

object

Show child attributes

data.relationships.logo.data.type

string

Allowed value: "media"

data.relationships.logo.data.id

string<uuid>

UUID of the logo media

Example:

"550e8400-e29b-41d4-a716-446655440010"

data.included

object

Object containing included resources referenced in relationships, organized by resource type. These are the actual created/linked resources with real UUIDs.

Show child attributes

data.included.published_by

object

Workspaces associated with this company

Show child attributes

data.included.published_by.data

object[]

Show child attributes

data.included.published_by.data.type

string

Allowed value: "workspace"

data.included.published_by.data.id

string<uuid>

UUID of the workspace

data.included.published_by.data.attributes

object

Show child attributes

data.included.published_by.data.attributes.name

string

required

Workspace name

Required string length: 1 - 255

data.included.published_by.data.attributes.description

string

Workspace description

Maximum string length: 1000

data.included.published_by.data.attributes.avatar_color

string

Avatar color in hexadecimal format (e.g., #FF5733)

data.included.published_by.data.attributes.external_workspace_id

string

External workspace identifier

Required string length: 1 - 255

data.included.media

object

Media files associated with this company

Show child attributes

data.included.media.data

object[]

Show child attributes

data.included.media.data.type

string

Allowed value: "media"

data.included.media.data.id

string<uuid>

UUID of the media

data.included.media.data.attributes

object

Show child attributes

data.included.media.data.attributes.media_type

enum<string>

Available options:

avatar,

logo,

banner

data.included.media.data.attributes.url

string<uri>

URL to the media file

data.included.media.data.attributes.is_primary

boolean

Whether this is the primary media

data.included.media.data.attributes.processed_at

string<date-time>

Timestamp when media processing completed

data.included.media.data.attributes.uploaded_at

string<date-time>

Delete Company Get Connectors by id

⌘I

Main Resources

Atomic Resources

System

Headers

Body

Response