HTTP Connectors
HTTP Connectors define reusable API frameworks — base URIs, versioning strategies, authentication presets, and supported-by rules — that HTTP connections, iClients, imports, and exports inherit.
Each connector has one or more versions and may group multiple API products under apis[]. Child resources (HTTP Connector Resources and Endpoints) define the specific operations available.
Two structural patterns exist:
Flat — versions and baseURIs sit directly on the connector. Most connectors use this pattern.
Grouped — the connector nests API products under
apis[], each with its own versions and baseURIs.
HTTP connector schema
Returns all HTTP Connectors visible to the authenticated account. The list response is abridged -- it omits published, baseURIs, supportedBy, and other detail fields. Use the by-ID endpoint for the full object.
When true, only return published HTTP Connectors.
Successfully retrieved list of HTTP Connectors.
Abridged HTTP Connector returned in list responses. Omits published,
baseURIs, supportedBy, apis, versioning, and write-only fields
compared to the detail endpoint.
Unique identifier for the resource. Format is a 24-character hexadecimal string.
63987132784a39b73aae63cdDisplay name for this HTTP Connector.
15FiveUser who created this connector.
6316f2b1e37e79778a43391cTimestamp when the resource was created. Set automatically and cannot be modified.
2023-01-17T09:51:46.326ZTimestamp when the resource was last updated. Changes whenever any property is modified.
2025-09-02T09:15:49.168ZDocumentation URL shown to users when configuring this connector.
https://docs.celigo.com/hc/en-us/articles/4411468706203Legacy assistant ID for backward compatibility.
15fiveAll legacy assistant IDs associated with this connector.
When true, this connector targets a GraphQL API.
When true, this connector supports shared iClient credentials.
When true, this connector supports webhook-based exports.
When true, at least one endpoint under this connector handles binary/blob data.
Present only when the connector uses staged metadata loading. Omitted
when the stored strategy is full.
No HTTP Connectors match the filter criteria.
Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.
Note: the 401 response is produced by the auth middleware before the
request reaches the endpoint handler, so it does not follow the
standard {errors: [...]} envelope. Instead the body is a bare
{message: string} object with no code, no errors array. Callers
handling 401s should key off the HTTP status and the message string,
not try to destructure an errors[].
GET /v1/httpconnectors HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"_id": "63987132784a39b73aae63cd",
"name": "15Five",
"createdAt": "2023-01-17T09:51:46.326Z",
"lastModified": "2025-09-02T09:15:49.168Z",
"_userId": "6316f2b1e37e79778a43391c",
"helpURL": "https://docs.celigo.com/hc/en-us/articles/4411468706203",
"legacyId": "15five",
"legacyIds": [
"15five"
],
"isGraphQL": false,
"supportsIClient": false,
"hasBlobEndpoints": false,
"versions": [
{
"_id": "63987132784a39b73aae63ce",
"name": "v1"
}
]
},
{
"_id": "6a1b2c3d4e5f6789abcdef01",
"name": "AFAS ERP",
"createdAt": "2025-10-28T13:32:39.999Z",
"lastModified": "2025-11-12T08:56:03.102Z",
"_userId": "6316f2b1e37e79778a43391c",
"helpURL": "https://docs.celigo.com/hc/en-us/articles/42612451102235",
"isGraphQL": false,
"supportsIClient": true,
"hasBlobEndpoints": false,
"apis": [
{
"_id": "6a1b2c3d4e5f6789abcdef02",
"name": "Profit",
"versions": [
{
"_id": "6a1b2c3d4e5f6789abcdef03",
"name": "v1"
}
]
}
]
}
]Creates a new HTTP Connector framework definition. name is required, along with either versions (flat connector) or apis (grouped connector).
Fields for creating or updating an HTTP Connector. name is always
required. On create, provide either versions (flat connector) or
apis (grouped connector) -- most connectors use the flat pattern.
Display name for this HTTP Connector.
Acme APIWhen true, this connector is visible to users.
Base URI templates (used when apis is empty).
Documentation URL shown to users when configuring this connector.
https://docs.celigo.com/hc/en-us/articles/4411468706203Legacy assistant ID for backward compatibility.
acmeWhen true, this connector targets a GraphQL API.
Require request body matching when auto-linking exports/imports.
Disable automatic linking of exports/imports to this connector.
HTTP Connector created successfully.
HTTP Connector object as returned by the detail (by-ID) endpoint.
Display name for this HTTP Connector.
Acme APIWhen true, this connector is visible to users.
Base URI templates (used when apis is empty).
Documentation URL shown to users when configuring this connector.
https://docs.celigo.com/hc/en-us/articles/4411468706203Legacy assistant ID for backward compatibility.
acmeWhen true, this connector targets a GraphQL API.
Require request body matching when auto-linking exports/imports.
Disable automatic linking of exports/imports to this connector.
Unique identifier for the resource. Format is a 24-character hexadecimal string.
5f8d43a1b9e5a80011a35f2cTimestamp when the resource was created. Set automatically and cannot be modified.
2023-04-01T09:15:32ZTimestamp when the resource was last updated. Changes whenever any property is modified.
2023-04-15T14:30:15ZTimestamp when the resource was soft-deleted. When null or absent, the resource is active.
2023-05-20T11:45:32ZUser who created this connector.
6316f2b1e37e79778a43391cAll legacy assistant IDs associated with this connector.
When true, this connector supports shared iClient credentials.
When true, this connector supports webhook-based exports.
When true, at least one endpoint under this connector handles binary/blob data.
Present only when the connector uses staged metadata loading. Omitted
when the stored strategy is full.
Number of blob endpoints for this connector
2Bad request. The server could not understand the request because of malformed syntax or invalid parameters.
Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.
Note: the 401 response is produced by the auth middleware before the
request reaches the endpoint handler, so it does not follow the
standard {errors: [...]} envelope. Instead the body is a bare
{message: string} object with no code, no errors array. Callers
handling 401s should key off the HTTP status and the message string,
not try to destructure an errors[].
Forbidden. The authenticated caller does not have permission to perform this operation.
Unprocessable entity. The request was well-formed but was unable to be followed due to semantic errors.
POST /v1/httpconnectors HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 188
{
"name": "Acme API",
"baseURIs": [
"https://api.acme.com"
],
"versions": [
{
"name": "v1",
"published": true
}
],
"supportedBy": {
"connection": {
"preConfiguredFields": [
{
"path": "type",
"values": [
"http"
]
}
]
}
}
}{
"_id": "63987132784a39b73aae63cd",
"_userId": "6316f2b1e37e79778a43391c",
"name": "15Five",
"createdAt": "2023-01-17T09:51:46.326Z",
"lastModified": "2023-01-17T09:51:46.326Z",
"published": true,
"isGraphQL": false,
"requireBodyMatchForLinking": false,
"disableAutoLinking": false,
"baseURIs": [
"https://my.15five.com"
],
"helpURL": "https://docs.celigo.com/hc/en-us/articles/4411468706203",
"legacyId": "15five",
"versions": [
{
"_id": "63987132784a39b73aae63ce",
"name": "v1",
"published": true,
"supportedBy": {}
}
],
"apis": [],
"supportedBy": {
"export": {
"preConfiguredFields": [
{
"path": "successMediaType",
"values": [
"json"
]
}
]
},
"connection": {
"preConfiguredFields": [
{
"path": "type",
"values": [
"http"
]
}
]
}
}
}Retrieves the full HTTP Connector object including published, baseURIs, supportedBy, and version details omitted from the list endpoint.
HTTP Connector ID.
HTTP Connector retrieved successfully.
HTTP Connector object as returned by the detail (by-ID) endpoint.
Display name for this HTTP Connector.
Acme APIWhen true, this connector is visible to users.
Base URI templates (used when apis is empty).
Documentation URL shown to users when configuring this connector.
https://docs.celigo.com/hc/en-us/articles/4411468706203Legacy assistant ID for backward compatibility.
acmeWhen true, this connector targets a GraphQL API.
Require request body matching when auto-linking exports/imports.
Disable automatic linking of exports/imports to this connector.
Unique identifier for the resource. Format is a 24-character hexadecimal string.
5f8d43a1b9e5a80011a35f2cTimestamp when the resource was created. Set automatically and cannot be modified.
2023-04-01T09:15:32ZTimestamp when the resource was last updated. Changes whenever any property is modified.
2023-04-15T14:30:15ZTimestamp when the resource was soft-deleted. When null or absent, the resource is active.
2023-05-20T11:45:32ZUser who created this connector.
6316f2b1e37e79778a43391cAll legacy assistant IDs associated with this connector.
When true, this connector supports shared iClient credentials.
When true, this connector supports webhook-based exports.
When true, at least one endpoint under this connector handles binary/blob data.
Present only when the connector uses staged metadata loading. Omitted
when the stored strategy is full.
Number of blob endpoints for this connector
2Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.
Note: the 401 response is produced by the auth middleware before the
request reaches the endpoint handler, so it does not follow the
standard {errors: [...]} envelope. Instead the body is a bare
{message: string} object with no code, no errors array. Callers
handling 401s should key off the HTTP status and the message string,
not try to destructure an errors[].
Forbidden. The authenticated caller does not have permission to perform this operation.
Not found. The requested resource does not exist or is not visible to the caller.
GET /v1/httpconnectors/{_id} HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"_id": "63987132784a39b73aae63cd",
"_userId": "6316f2b1e37e79778a43391c",
"name": "15Five",
"createdAt": "2023-01-17T09:51:46.326Z",
"lastModified": "2025-09-02T09:15:49.168Z",
"published": true,
"isGraphQL": false,
"requireBodyMatchForLinking": false,
"disableAutoLinking": false,
"baseURIs": [
"https://my.15five.com"
],
"helpURL": "https://docs.celigo.com/hc/en-us/articles/4411468706203",
"legacyId": "15five",
"versions": [
{
"_id": "63987132784a39b73aae63ce",
"name": "v1",
"published": true,
"supportedBy": {}
}
],
"apis": [],
"supportedBy": {
"export": {
"preConfiguredFields": [
{
"path": "successMediaType",
"values": [
"json"
]
}
]
},
"connection": {
"preConfiguredFields": [
{
"path": "type",
"values": [
"http"
]
}
]
}
}
}Replaces the HTTP Connector with the provided fields.
HTTP Connector ID.
Fields for creating or updating an HTTP Connector. name is always
required. On create, provide either versions (flat connector) or
apis (grouped connector) -- most connectors use the flat pattern.
Display name for this HTTP Connector.
Acme APIWhen true, this connector is visible to users.
Base URI templates (used when apis is empty).
Documentation URL shown to users when configuring this connector.
https://docs.celigo.com/hc/en-us/articles/4411468706203Legacy assistant ID for backward compatibility.
acmeWhen true, this connector targets a GraphQL API.
Require request body matching when auto-linking exports/imports.
Disable automatic linking of exports/imports to this connector.
HTTP Connector updated successfully.
HTTP Connector object as returned by the detail (by-ID) endpoint.
Display name for this HTTP Connector.
Acme APIWhen true, this connector is visible to users.
Base URI templates (used when apis is empty).
Documentation URL shown to users when configuring this connector.
https://docs.celigo.com/hc/en-us/articles/4411468706203Legacy assistant ID for backward compatibility.
acmeWhen true, this connector targets a GraphQL API.
Require request body matching when auto-linking exports/imports.
Disable automatic linking of exports/imports to this connector.
Unique identifier for the resource. Format is a 24-character hexadecimal string.
5f8d43a1b9e5a80011a35f2cTimestamp when the resource was created. Set automatically and cannot be modified.
2023-04-01T09:15:32ZTimestamp when the resource was last updated. Changes whenever any property is modified.
2023-04-15T14:30:15ZTimestamp when the resource was soft-deleted. When null or absent, the resource is active.
2023-05-20T11:45:32ZUser who created this connector.
6316f2b1e37e79778a43391cAll legacy assistant IDs associated with this connector.
When true, this connector supports shared iClient credentials.
When true, this connector supports webhook-based exports.
When true, at least one endpoint under this connector handles binary/blob data.
Present only when the connector uses staged metadata loading. Omitted
when the stored strategy is full.
Number of blob endpoints for this connector
2Bad request. The server could not understand the request because of malformed syntax or invalid parameters.
Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.
Note: the 401 response is produced by the auth middleware before the
request reaches the endpoint handler, so it does not follow the
standard {errors: [...]} envelope. Instead the body is a bare
{message: string} object with no code, no errors array. Callers
handling 401s should key off the HTTP status and the message string,
not try to destructure an errors[].
Forbidden. The authenticated caller does not have permission to perform this operation.
Not found. The requested resource does not exist or is not visible to the caller.
Unprocessable entity. The request was well-formed but was unable to be followed due to semantic errors.
PUT /v1/httpconnectors/{_id} HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 452
{
"name": "15Five",
"published": true,
"isGraphQL": false,
"requireBodyMatchForLinking": false,
"disableAutoLinking": true,
"baseURIs": [
"https://my.15five.com"
],
"helpURL": "https://docs.celigo.com/hc/en-us/articles/4411468706203",
"legacyId": "15five",
"versions": [
{
"name": "v1",
"published": true
}
],
"supportedBy": {
"export": {
"preConfiguredFields": [
{
"path": "successMediaType",
"values": [
"json"
]
}
]
},
"connection": {
"preConfiguredFields": [
{
"path": "type",
"values": [
"http"
]
}
]
}
}
}{
"_id": "63987132784a39b73aae63cd",
"_userId": "6316f2b1e37e79778a43391c",
"name": "15Five",
"createdAt": "2023-01-17T09:51:46.326Z",
"lastModified": "2025-09-10T11:42:17.553Z",
"published": true,
"isGraphQL": false,
"requireBodyMatchForLinking": false,
"disableAutoLinking": true,
"baseURIs": [
"https://my.15five.com"
],
"helpURL": "https://docs.celigo.com/hc/en-us/articles/4411468706203",
"legacyId": "15five",
"versions": [
{
"_id": "63987132784a39b73aae63ce",
"name": "v1",
"published": true,
"supportedBy": {}
}
],
"apis": [],
"supportedBy": {
"export": {
"preConfiguredFields": [
{
"path": "successMediaType",
"values": [
"json"
]
}
]
},
"connection": {
"preConfiguredFields": [
{
"path": "type",
"values": [
"http"
]
}
]
}
}
}Permanently deletes an HTTP Connector and all its child resources and endpoints.
HTTP Connector ID.
HTTP Connector deleted successfully.
No content
Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.
Note: the 401 response is produced by the auth middleware before the
request reaches the endpoint handler, so it does not follow the
standard {errors: [...]} envelope. Instead the body is a bare
{message: string} object with no code, no errors array. Callers
handling 401s should key off the HTTP status and the message string,
not try to destructure an errors[].
Forbidden. The authenticated caller does not have permission to perform this operation.
Not found. The requested resource does not exist or is not visible to the caller.
DELETE /v1/httpconnectors/{_id} HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Returns projected resource and endpoint summaries for one import or export plane. Import catalogs may include derived ignoreExisting, ignoreMissing, and isIdentifierPresent flags on endpoints. Export catalogs return endpoint { id, name } only. Published-only requests may be served from the MongoDB catalog cache and include an X-Catalog-Cache response header.
HTTP Connector ID.
63987132784a39b73aae63cdResource plane to project.
Selects the blob or non-blob endpoint plane.
Optional API group scope filter.
6a1b2c3d4e5f6789abcdef02Optional version scope filter.
63987132784a39b73aae63ceWhen true, only published documents are returned and eligible requests
may be served from the catalog cache.
Form metadata catalog retrieved successfully.
Bad request. The server could not understand the request because of malformed syntax or invalid parameters.
Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.
Note: the 401 response is produced by the auth middleware before the
request reaches the endpoint handler, so it does not follow the
standard {errors: [...]} envelope. Instead the body is a bare
{message: string} object with no code, no errors array. Callers
handling 401s should key off the HTTP status and the message string,
not try to destructure an errors[].
Not found. The requested resource does not exist or is not visible to the caller.
GET /v1/httpconnectors/{_id}/catalog?resourceType=export&blob=true HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"resources": [
{
"id": "63987132784a39b73aae63e7",
"name": "Orders",
"endpoints": [
{
"id": "63987132784a39b73aae63f1",
"name": "Get orders"
}
]
}
]
}Returns scoped httpConnectorResource and httpConnectorEndpoint documents for a single export/import endpoint, or a paired import create/update batch. Lookup endpoints may be inlined when they are published and belong to the same connector. endpointId and endpointIds are mutually exclusive; endpointIds is only valid when resourceType is import and must contain exactly two comma-separated ObjectIds. Composite id1+id2 values are rejected.
HTTP Connector ID.
63987132784a39b73aae63cdResource plane to resolve.
HTTP Connector Resource ID that belongs to this connector.
63987132784a39b73aae63e7Selects the blob or non-blob endpoint plane.
Single endpoint ID. Mutually exclusive with endpointIds.
63987132784a39b73aae63f1Comma-separated pair of import endpoint IDs for create/update batch
mode. Import only; exactly two unique IDs. Mutually exclusive with
endpointId.
63987132784a39b73aae63f1,63987132784a39b73aae63f2Optional API group scope filter.
6a1b2c3d4e5f6789abcdef02Optional version scope filter; echoed as resolvedVersionId when present.
63987132784a39b73aae63ceWhen true, only published documents are returned.
Resource and endpoint detail retrieved successfully.
Scoped resource and endpoint metadata for the HTTP connector form.
Single-endpoint requests return resolvedEndpointId and
httpConnectorEndpoint. Import batch requests (endpointIds) return
resolvedEndpointIds and httpConnectorEndpoints instead.
Resource ID resolved for the request.
63987132784a39b73aae63e7Endpoint ID for single-endpoint requests. Present when resolvedEndpointIds is absent.
63987132784a39b73aae63f1Create/update endpoint ID pair for import batch requests. Present for batch responses.
Echoed when a version scope filter was supplied on the request.
63987132784a39b73aae63ceBad request. The server could not understand the request because of malformed syntax or invalid parameters.
Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.
Note: the 401 response is produced by the auth middleware before the
request reaches the endpoint handler, so it does not follow the
standard {errors: [...]} envelope. Instead the body is a bare
{message: string} object with no code, no errors array. Callers
handling 401s should key off the HTTP status and the message string,
not try to destructure an errors[].
Not found. The requested resource does not exist or is not visible to the caller.
GET /v1/httpconnectors/{_id}/resourceEndpointDetail?resourceType=export&resourceId=63987132784a39b73aae63e7&blob=true HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"resolvedResourceId": "63987132784a39b73aae63e7",
"resolvedEndpointId": "63987132784a39b73aae63f1",
"httpConnectorResource": {
"_id": "63987132784a39b73aae63e7",
"name": "Orders"
},
"httpConnectorEndpoint": {
"_id": "63987132784a39b73aae63f1",
"name": "Get orders"
}
}Returns projected resource and endpoint summaries for one import or export plane. Import catalogs may include derived ignoreExisting, ignoreMissing, and isIdentifierPresent flags on endpoints. Export catalogs return endpoint { id, name } only. Published-only requests may be served from the MongoDB catalog cache and include an X-Catalog-Cache response header.
HTTP Connector ID.
63987132784a39b73aae63cdResource plane to project.
Selects the blob or non-blob endpoint plane.
Optional API group scope filter.
6a1b2c3d4e5f6789abcdef02Optional version scope filter.
63987132784a39b73aae63ceWhen true, only published documents are returned and eligible requests
may be served from the catalog cache.
Form metadata catalog retrieved successfully.
Bad request. The server could not understand the request because of malformed syntax or invalid parameters.
Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.
Note: the 401 response is produced by the auth middleware before the
request reaches the endpoint handler, so it does not follow the
standard {errors: [...]} envelope. Instead the body is a bare
{message: string} object with no code, no errors array. Callers
handling 401s should key off the HTTP status and the message string,
not try to destructure an errors[].
Not found. The requested resource does not exist or is not visible to the caller.
GET /api/httpconnectors/{_id}/catalog?resourceType=export&blob=true HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"resources": [
{
"id": "63987132784a39b73aae63e7",
"name": "Orders",
"endpoints": [
{
"id": "63987132784a39b73aae63f1",
"name": "Get orders"
}
]
}
]
}Returns scoped httpConnectorResource and httpConnectorEndpoint documents for a single export/import endpoint, or a paired import create/update batch. Lookup endpoints may be inlined when they are published and belong to the same connector. endpointId and endpointIds are mutually exclusive; endpointIds is only valid when resourceType is import and must contain exactly two comma-separated ObjectIds. Composite id1+id2 values are rejected.
HTTP Connector ID.
63987132784a39b73aae63cdResource plane to resolve.
HTTP Connector Resource ID that belongs to this connector.
63987132784a39b73aae63e7Selects the blob or non-blob endpoint plane.
Single endpoint ID. Mutually exclusive with endpointIds.
63987132784a39b73aae63f1Comma-separated pair of import endpoint IDs for create/update batch
mode. Import only; exactly two unique IDs. Mutually exclusive with
endpointId.
63987132784a39b73aae63f1,63987132784a39b73aae63f2Optional API group scope filter.
6a1b2c3d4e5f6789abcdef02Optional version scope filter; echoed as resolvedVersionId when present.
63987132784a39b73aae63ceWhen true, only published documents are returned.
Resource and endpoint detail retrieved successfully.
Scoped resource and endpoint metadata for the HTTP connector form.
Single-endpoint requests return resolvedEndpointId and
httpConnectorEndpoint. Import batch requests (endpointIds) return
resolvedEndpointIds and httpConnectorEndpoints instead.
Resource ID resolved for the request.
63987132784a39b73aae63e7Endpoint ID for single-endpoint requests. Present when resolvedEndpointIds is absent.
63987132784a39b73aae63f1Create/update endpoint ID pair for import batch requests. Present for batch responses.
Echoed when a version scope filter was supplied on the request.
63987132784a39b73aae63ceBad request. The server could not understand the request because of malformed syntax or invalid parameters.
Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.
Note: the 401 response is produced by the auth middleware before the
request reaches the endpoint handler, so it does not follow the
standard {errors: [...]} envelope. Instead the body is a bare
{message: string} object with no code, no errors array. Callers
handling 401s should key off the HTTP status and the message string,
not try to destructure an errors[].
Not found. The requested resource does not exist or is not visible to the caller.
GET /api/httpconnectors/{_id}/resourceEndpointDetail?resourceType=export&resourceId=63987132784a39b73aae63e7&blob=true HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"resolvedResourceId": "63987132784a39b73aae63e7",
"resolvedEndpointId": "63987132784a39b73aae63f1",
"httpConnectorResource": {
"_id": "63987132784a39b73aae63e7",
"name": "Orders"
},
"httpConnectorEndpoint": {
"_id": "63987132784a39b73aae63f1",
"name": "Get orders"
}
}Last updated
Was this helpful?