connectors

Embed

<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/v1/integrations/catalog

Declarative connectors available to connect

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/catalog" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "category": "string",
      "docsUrl": "string",
      "logo": "string",
      "summary": "string",
      "auth": "api_key",
      "oauthBrowser": true,
      "fields": [
        {
          "key": "string",
          "label": "string",
          "help": "string",
          "secret": true,
          "optional": true,
          "url": true,
          "placeholder": "string"
        }
      ],
      "events": [
        "string"
      ],
      "syncs": [
        "string"
      ],
      "webhooks": true,
      "consent": "string",
      "verified": true,
      "notes": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

namestringrequired

categorystringrequired

docsUrlstringrequired

logostringrequired

summarystringrequired

authstringrequired

oauthBrowserbooleanrequired

fieldsobject[]required

Show child parameters

keystringrequired

labelstringrequired

helpstring

secretbooleanrequired

optionalbooleanrequired

urlbooleanrequired

placeholderstring

eventsstring[]required

syncsstring[]required

webhooksbooleanrequired

consentstringrequired

verifiedbooleanrequired

notesstringrequired

nextCursorstringrequired

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 /v1/integrations/catalog

POSThttps://hermeticor.com/v1/integrations/declarative/connect

Connect a catalog connector from its manifest fields; OAuth connectors return the authorize URL

Request body

application/json

manifestIdstringrequired

namestringrequired

valuesobjectrequired

{
  "manifestId": "string",
  "name": "string",
  "values": {}
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/integrations/declarative/connect" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"manifestId":"string","name":"string","values":{}}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "connectionId": "string",
  "authorizeUrl": "string",
  "webhook": {
    "url": "string",
    "secret": "string",
    "verifyToken": "string",
    "signature": "string",
    "setup": "string",
    "capturedCode": "string",
    "capturedAt": "2024-01-01T00:00:00Z"
  }
}

Schema

connectionIdstringrequired

authorizeUrlstringrequired

webhookobjectrequired

Show child parameters

urlstringrequired

secretstringrequired

verifyTokenstringrequired

signaturestringrequired

setupstringrequired

capturedCodestringrequired

capturedAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/integrations/catalog

5XX Default Response

Same as 4XX · GET /v1/integrations/catalog

GEThttps://hermeticor.com/v1/integrations/connections/{id}/declarative

Sync cursors, last error and the webhook URL + secret to paste into the vendor

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/integrations/connections/{id}/declarative" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "manifestId": "string",
  "status": "string",
  "lastSyncAt": "2024-01-01T00:00:00Z",
  "lastError": "string",
  "webhook": {
    "url": "string",
    "secret": "string",
    "verifyToken": "string",
    "signature": "string",
    "setup": "string",
    "capturedCode": "string",
    "capturedAt": "2024-01-01T00:00:00Z"
  },
  "secretRotatable": true,
  "secretPastable": true,
  "secretSet": true,
  "push": {
    "available": true,
    "enabled": true,
    "segmentId": "string"
  },
  "streams": [
    {
      "name": "string",
      "cursor": "string",
      "done": true
    }
  ]
}

Schema

manifestIdstringrequired

statusstringrequired

lastSyncAtstringrequired

lastErrorstringrequired

webhookobjectrequired

Show child parameters

urlstringrequired

secretstringrequired

verifyTokenstringrequired

signaturestringrequired

setupstringrequired

capturedCodestringrequired

capturedAtstringrequired

secretRotatablebooleanrequired

secretPastablebooleanrequired

secretSetbooleanrequired

pushobjectrequired

Show child parameters

availablebooleanrequired

enabledbooleanrequired

segmentIdstringrequired

streamsobject[]required

Show child parameters

namestringrequired

cursorstringrequired

donebooleanrequired

4XX Default Response

Same as 4XX · GET /v1/integrations/catalog

5XX Default Response

Same as 4XX · GET /v1/integrations/catalog

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

Forget the cursors and re-read the vendor from the beginning

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/integrations/connections/{id}/resync" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

202 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/integrations/catalog

5XX Default Response

Same as 4XX · GET /v1/integrations/catalog

POSThttps://hermeticor.com/v1/integrations/connections/{id}/declarative/rotate-webhook-secret

Generate a new webhook secret; the new value is returned once and the old one stops working

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/integrations/connections/{id}/declarative/rotate-webhook-secret" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "url": "string",
  "secret": "string",
  "verifyToken": "string",
  "signature": "string",
  "setup": "string",
  "capturedCode": "string",
  "capturedAt": "2024-01-01T00:00:00Z"
}

Schema

urlstringrequired

secretstringrequired

verifyTokenstringrequired

signaturestringrequired

setupstringrequired

capturedCodestringrequired

capturedAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/integrations/catalog

5XX Default Response

Same as 4XX · GET /v1/integrations/catalog

PUThttps://hermeticor.com/v1/integrations/connections/{id}/declarative/webhook-secret

Save the signing secret the vendor shows only after it verified the webhook URL (e.g. Clover X-Clover-Auth); it is never returned

Parameters

idstringpathrequired

Request body

application/json

secretstringrequired

{
  "secret": "string"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/integrations/connections/{id}/declarative/webhook-secret" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"secret":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 202 · POST /v1/integrations/connections/{id}/resync

4XX Default Response

Same as 4XX · GET /v1/integrations/catalog

5XX Default Response

Same as 4XX · GET /v1/integrations/catalog

PUThttps://hermeticor.com/v1/integrations/connections/{id}/declarative/push

Turn on sending changed profiles to this CRM/helpdesk (off by default), optionally for one segment

Parameters

idstringpathrequired

Request body

application/json

enabledbooleanrequired

segmentIdstring

{
  "enabled": true,
  "segmentId": "string"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/integrations/connections/{id}/declarative/push" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true,"segmentId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 202 · POST /v1/integrations/connections/{id}/resync

4XX Default Response

Same as 4XX · GET /v1/integrations/catalog

5XX Default Response

Same as 4XX · GET /v1/integrations/catalog

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

Catalogue packages, whether each passes signature and review checks, and the installed version

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/integrations/marketplace" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "configured": true,
  "items": [
    {
      "id": "string",
      "version": "string",
      "name": "string",
      "publisher": "string",
      "summary": "string",
      "reviewStatus": "string",
      "installable": true,
      "problem": "string",
      "installedVersion": "string"
    }
  ]
}

Schema

configuredbooleanrequired

itemsobject[]required

Show child parameters

idstringrequired

versionstringrequired

namestringrequired

publisherstringrequired

summarystringrequired

reviewStatusstringrequired

installablebooleanrequired

problemstringrequired

installedVersionstringrequired

4XX Default Response

Same as 4XX · GET /v1/integrations/catalog

5XX Default Response

Same as 4XX · GET /v1/integrations/catalog

Next part

Updated Nov 8, 2026

Was this page helpful?