connections

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-connections"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/f97af7f7-078d-4412-8c6a-b40f548f2c71/social-card.svg?v=3e7ae33eec8b" alt="connections" width="600" height="315"></a>
GEThttps://hermeticor.com/v1/connections/oauth/providers

Code samples

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

Responses

200 Default Response
Example
{
  "google": true,
  "microsoft": true
}
Schema
googlebooleanrequired
microsoftbooleanrequired
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/connections/oauth/providers

POSThttps://hermeticor.com/v1/connections/oauth/{provider}/start

Parameters

providerstringpathrequired
google | microsoft

Request body

application/json
reconnectConnectionIdstring
loginHintstring
namestring
{
  "reconnectConnectionId": "string",
  "loginHint": "string",
  "name": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/connections/oauth/{provider}/start" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"reconnectConnectionId":"string","loginHint":"string","name":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

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

Same as 4XX · GET /v1/connections/oauth/providers

5XX Default Response

Same as 4XX · GET /v1/connections/oauth/providers

GEThttps://hermeticor.com/v1/connections/oauth/callback

Parameters

codestringquery
statestringquery
errorstringquery
error_descriptionstringquery

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/connections/oauth/callback"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

302 Default Response
"string"
4XX Default Response

Same as 4XX · GET /v1/connections/oauth/providers

5XX Default Response

Same as 4XX · GET /v1/connections/oauth/providers

GEThttps://hermeticor.com/v1/providers

Provider kinds you can connect, with the `credentials` / `config` fields each needs (required, secret). Missing required fields are a 400 before any provider call. No provider yet? On a server with the demo sink, connect kind `smtp` to host `hermetica-mailpit`, port 1025, no user: mail is caught, never delivered.

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/providers" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "kind": "string",
      "channel": "email",
      "family": "mailbox",
      "capabilities": {
        "send": true,
        "scheduledSend": true,
        "deliveryEvents": true,
        "deliveryDelayEvents": true,
        "complaintEvents": true,
        "openTracking": true,
        "clickTracking": true,
        "suppressionSync": true,
        "templates": true,
        "idempotencyKey": true,
        "safeRetryOnUnknown": true,
        "batchSend": true,
        "customHeaders": true,
        "mms": true,
        "alphanumericSender": true,
        "returnsMessageId": true,
        "bounceEvents": "none",
        "inboundReplies": "none",
        "webhookAuth": "hmac",
        "rateLimit": {
          "perSecond": 0,
          "perMinute": 0,
          "perDay": 0,
          "concurrent": 0
        },
        "maxRecipientsPerCall": 0
      },
      "credentialFields": [
        {
          "key": "string",
          "label": "string",
          "target": "credentials",
          "type": "text",
          "hint": "string",
          "required": true,
          "secret": true,
          "mono": true
        }
      ]
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
kindstringrequired
channelstringrequired
email | sms | whatsapp | linkedin | push | postcard
familystringrequired
mailbox | smtp | email_api | sms_api | whatsapp_api | linkedin_api | push_api | print_api
capabilitiesobjectrequired
Show child parameters
sendbooleanrequired
scheduledSendbooleanrequired
deliveryEventsbooleanrequired
deliveryDelayEventsbooleanrequired
complaintEventsbooleanrequired
openTrackingbooleanrequired
clickTrackingbooleanrequired
suppressionSyncbooleanrequired
templatesbooleanrequired
idempotencyKeybooleanrequired
safeRetryOnUnknownbooleanrequired
batchSendbooleanrequired
customHeadersbooleanrequired
mmsbooleanrequired
alphanumericSenderbooleanrequired
returnsMessageIdbooleanrequired
bounceEventsstringrequired
none | parsed | native
inboundRepliesstringrequired
none | native | separate
webhookAuthstringrequired
hmac | rsa | ecdsa | ed25519 | svix | basic_ip | shared_token | twilio_sig | sns | none
rateLimitobjectrequired
maxRecipientsPerCallintegerrequired
credentialFieldsobject[]required
Show child parameters
keystringrequired
labelstringrequired
targetstringrequired
credentials | config
typestring
text | password | number | boolean | multiline
hintstring
requiredboolean
secretboolean
monoboolean
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/connections/oauth/providers

5XX Default Response

Same as 4XX · GET /v1/connections/oauth/providers

GEThttps://hermeticor.com/v1/connections

Parameters

limitintegerquery
= 50
cursorstringquery

Code samples

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "kind": "string",
      "family": "mailbox",
      "name": "string",
      "purposesAllowed": [
        "string"
      ],
      "capabilities": {
        "send": true,
        "scheduledSend": true,
        "deliveryEvents": true,
        "deliveryDelayEvents": true,
        "complaintEvents": true,
        "openTracking": true,
        "clickTracking": true,
        "suppressionSync": true,
        "templates": true,
        "idempotencyKey": true,
        "safeRetryOnUnknown": true,
        "batchSend": true,
        "customHeaders": true,
        "mms": true,
        "alphanumericSender": true,
        "returnsMessageId": true,
        "bounceEvents": "none",
        "inboundReplies": "none",
        "webhookAuth": "hmac",
        "rateLimit": {
          "perSecond": 0,
          "perMinute": 0,
          "perDay": 0,
          "concurrent": 0
        },
        "maxRecipientsPerCall": 0
      },
      "health": "healthy",
      "healthDetail": {},
      "lastSuccessAt": "2024-01-01T00:00:00Z",
      "dailyCap": 0,
      "hourlyCap": 0,
      "ramp": {},
      "timezone": "string",
      "sendingWindow": {},
      "config": {},
      "status": "active",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem19[]required
Show child parameters
idstringrequired
kindstringrequired
familystringrequired
mailbox | smtp | email_api | sms_api | whatsapp_api | linkedin_api | push_api | print_api
namestringrequired
purposesAllowedstring[]required
capabilitiesobjectrequired
Show child parameters
sendbooleanrequired
scheduledSendbooleanrequired
deliveryEventsbooleanrequired
deliveryDelayEventsbooleanrequired
complaintEventsbooleanrequired
openTrackingbooleanrequired
clickTrackingbooleanrequired
suppressionSyncbooleanrequired
templatesbooleanrequired
idempotencyKeybooleanrequired
safeRetryOnUnknownbooleanrequired
batchSendbooleanrequired
customHeadersbooleanrequired
mmsbooleanrequired
alphanumericSenderbooleanrequired
returnsMessageIdbooleanrequired
bounceEventsstringrequired
none | parsed | native
inboundRepliesstringrequired
none | native | separate
webhookAuthstringrequired
hmac | rsa | ecdsa | ed25519 | svix | basic_ip | shared_token | twilio_sig | sns | none
rateLimitobjectrequired
maxRecipientsPerCallintegerrequired
healthstringrequired
healthy | degraded | failing | disconnected
healthDetailrequired
lastSuccessAtstringrequired
dailyCapnumberrequired
hourlyCapnumberrequired
ramprequired
timezonestringrequired
sendingWindowrequired
configobjectrequired
Adapter settings. After an automatic pause, pausedReason = {reason, metric, value, threshold, sample, at, by, resume}; resuming clears it.
statusstringrequired
active | paused | archived
createdAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/connections/oauth/providers

5XX Default Response

Same as 4XX · GET /v1/connections/oauth/providers

Updated