connectors

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-connectors"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/b2c0834c-9a8e-4b46-af78-fde29588720f/social-card.svg?v=3e7ae33eec8b" alt="connectors" width="600" height="315"></a>
GEThttps://hermeticor.com/integrations/hubspot/callback

Parameters

typequery
additionalPropertiesstringquery

Code samples

cURL
curl -X GET "https://hermeticor.com/integrations/hubspot/callback"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
"string"
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /integrations/hubspot/callback

GEThttps://hermeticor.com/v1/integrations/connections

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/integrations/connections" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "kind": "hubspot",
      "name": "string",
      "config": {},
      "status": "active",
      "lastSyncAt": "2024-01-01T00:00:00Z",
      "lastError": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem104[]required
Show child parameters
idstringrequired
kindstringrequired
namestringrequired
configobjectrequired
statusstringrequired
active | error | disabled
lastSyncAtstringrequired
lastErrorstringrequired
createdAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /integrations/hubspot/callback

5XX Default Response

Same as 4XX · GET /integrations/hubspot/callback

POSThttps://hermeticor.com/v1/integrations/connections

Request body

application/json
kindstringrequired
hubspot | shopify | salesforce | pipedrive | dynamics | zendesk | segment | posthog | woocommerce | bigcommerce | stripe | s3 | bigquery | snowflake
namestringrequired
credentialsobjectrequired
configobject
{
  "kind": "hubspot",
  "name": "string",
  "credentials": {},
  "config": {}
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/integrations/connections" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"hubspot","name":"string","credentials":{},"config":{}}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "kind": "hubspot",
  "name": "string",
  "config": {},
  "status": "active",
  "lastSyncAt": "2024-01-01T00:00:00Z",
  "lastError": "string",
  "createdAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
kindstringrequired
namestringrequired
configobjectrequired
statusstringrequired
active | error | disabled
lastSyncAtstringrequired
lastErrorstringrequired
createdAtstringrequired
4XX Default Response

Same as 4XX · GET /integrations/hubspot/callback

5XX Default Response

Same as 4XX · GET /integrations/hubspot/callback

PATCHhttps://hermeticor.com/v1/integrations/connections/{id}/settings

CRM field and property mapping, lifecycle handoff rules, lead-status writeback and opt-out sync

Parameters

idstringpathrequired

Request body

application/json
fieldMapobject
leadStatusWritebackboolean
statusMapobject
leadStatusFieldstring
propertyMapobject
createMissingPropertiesboolean
lifecycleWritebackboolean
stageMapobject
lifecycleRegressboolean
exitLifecycleStagesstring[]
exitLeadStatusesstring[]
subscriptionTopicMapobject
pushOptOutsboolean
propagateMergesboolean
propagateErasureboolean
pushEnabledboolean
pushSegmentIdstring
companyPropertyMapobject
marketingEventsAccountIdstring
{
  "fieldMap": {},
  "leadStatusWriteback": true,
  "statusMap": {},
  "leadStatusField": "string",
  "propertyMap": {},
  "createMissingProperties": true,
  "lifecycleWriteback": true,
  "stageMap": {},
  "lifecycleRegress": true,
  "exitLifecycleStages": [
    "string"
  ],
  "exitLeadStatuses": [
    "string"
  ],
  "subscriptionTopicMap": {},
  "pushOptOuts": true,
  "propagateMerges": true,
  "propagateErasure": true,
  "pushEnabled": true,
  "pushSegmentId": "string",
  "companyPropertyMap": {},
  "marketingEventsAccountId": "string"
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/integrations/connections/{id}/settings" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fieldMap":{},"leadStatusWriteback":true,"statusMap":{},"leadStatusField":"string","propertyMap":{},"createMissingProperties":true,"lifecycleWriteback":true,"stageMap":{},"lifecycleRegress":true,"exitLifecycleStages":["string"],"exitLeadStatuses":["string"],"subscriptionTopicMap":{},"pushOptOuts":true,"propagateMerges":true,"propagateErasure":true,"pushEnabled":true,"pushSegmentId":"string","companyPropertyMap":{},"marketingEventsAccountId":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/integrations/connections

4XX Default Response

Same as 4XX · GET /integrations/hubspot/callback

5XX Default Response

Same as 4XX · GET /integrations/hubspot/callback

DELETEhttps://hermeticor.com/v1/integrations/connections/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/integrations/connections/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response

Same as 4XX · GET /integrations/hubspot/callback

5XX Default Response

Same as 4XX · GET /integrations/hubspot/callback

POSThttps://hermeticor.com/v1/integrations/connections/{id}/test

Make one real authenticated call to the connected system

Parameters

idstringpathrequired

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/integrations/connections/{id}/test" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true,
  "message": "string"
}
Schema
okbooleanrequired
messagestringrequired
4XX Default Response

Same as 4XX · GET /integrations/hubspot/callback

5XX Default Response

Same as 4XX · GET /integrations/hubspot/callback

GEThttps://hermeticor.com/v1/integrations/connections/{id}/webhook-url

The URL the source (e.g. Segment) should send events to

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/integrations/connections/{id}/webhook-url" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "url": "string"
}
Schema
urlstringrequired
4XX Default Response

Same as 4XX · GET /integrations/hubspot/callback

5XX Default Response

Same as 4XX · GET /integrations/hubspot/callback

POSThttps://hermeticor.com/v1/integrations/connections/{id}/sync

Queue a sync now

Parameters

idstringpathrequired

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/integrations/connections/{id}/sync" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

4XX Default Response

Same as 4XX · GET /integrations/hubspot/callback

5XX Default Response

Same as 4XX · GET /integrations/hubspot/callback

GEThttps://hermeticor.com/webhooks/integrations/{workspaceId}/{connectionId}

Parameters

workspaceIdstringpathrequired
connectionIdstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/webhooks/integrations/{workspaceId}/{connectionId}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
{}
4XX Default Response

Same as 4XX · GET /integrations/hubspot/callback

5XX Default Response

Same as 4XX · GET /integrations/hubspot/callback

POSThttps://hermeticor.com/webhooks/integrations/{workspaceId}/{connectionId}

Parameters

workspaceIdstringpathrequired
connectionIdstringpathrequired

Code samples

cURL
curl -X POST "https://hermeticor.com/webhooks/integrations/{workspaceId}/{connectionId}"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
{}
4XX Default Response

Same as 4XX · GET /integrations/hubspot/callback

5XX Default Response

Same as 4XX · GET /integrations/hubspot/callback

Updated