transactional

Embed

<a href="https://hermeticor.com/docs/ref-transactional"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/3cb76e64-a1f1-4ede-8c35-73d2172e4bf2/social-card.svg?v=3e7ae33eec8b" alt="transactional" width="600" height="315"></a>

POSThttps://hermeticor.com/v1/inbound/domains

Add an inbound domain; point its MX at expectedMx, then call /check

Request body

application/json

domainstringrequired

{
  "domain": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/inbound/domains" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "domain": "string",
  "mxVerifiedAt": "2024-01-01T00:00:00Z",
  "lastCheckedAt": "2024-01-01T00:00:00Z",
  "mx": {},
  "expectedMx": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "receiveUrls": {}
}

Schema

idstringrequired

domainstringrequired

mxVerifiedAtstringrequired

lastCheckedAtstringrequired

mxrequired

expectedMxstringrequired

createdAtstringrequired

receiveUrlsobject

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · POST /v1/inbound/domains

POSThttps://hermeticor.com/v1/inbound/domains/{id}/check

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/inbound/domains/{id}/check" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/inbound/domains

4XX Default Response

Same as 4XX · POST /v1/inbound/domains

5XX Default Response

Same as 4XX · POST /v1/inbound/domains

DELETEhttps://hermeticor.com/v1/inbound/domains/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/inbound/domains/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · POST /v1/inbound/domains

5XX Default Response

Same as 4XX · POST /v1/inbound/domains

GEThttps://hermeticor.com/v1/inbound/routes

Parameters

domainIdstringquery

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "domainId": "string",
      "pattern": "string",
      "webhookUrl": "string",
      "enabled": true,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem45[]required

Show child parameters

idstringrequired

domainIdstringrequired

patternstringrequired

webhookUrlstringrequired

enabledbooleanrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/inbound/domains

5XX Default Response

Same as 4XX · POST /v1/inbound/domains

POSThttps://hermeticor.com/v1/inbound/routes

Request body

application/json

domainIdstringrequired

patternstringrequired

webhookUrlstringrequired

{
  "domainId": "string",
  "pattern": "string",
  "webhookUrl": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/inbound/routes" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domainId":"string","pattern":"string","webhookUrl":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "domainId": "string",
  "pattern": "string",
  "webhookUrl": "string",
  "enabled": true,
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

domainIdstringrequired

patternstringrequired

webhookUrlstringrequired

enabledbooleanrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · POST /v1/inbound/domains

5XX Default Response

Same as 4XX · POST /v1/inbound/domains

DELETEhttps://hermeticor.com/v1/inbound/routes/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/inbound/routes/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/inbound/domains/{id}

4XX Default Response

Same as 4XX · POST /v1/inbound/domains

5XX Default Response

Same as 4XX · POST /v1/inbound/domains

PATCHhttps://hermeticor.com/v1/inbound/routes/{id}

Parameters

idstringpathrequired

Request body

application/json

patternstring

webhookUrlstring

enabledboolean

{
  "pattern": "string",
  "webhookUrl": "string",
  "enabled": true
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/inbound/routes/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"pattern":"string","webhookUrl":"string","enabled":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/inbound/routes

4XX Default Response

Same as 4XX · POST /v1/inbound/domains

5XX Default Response

Same as 4XX · POST /v1/inbound/domains

POSThttps://hermeticor.com/v1/inbound/simulate

Run a fake inbound mail through the domain's routes (queues the webhook deliveries)

Request body

application/json

domainIdstringrequired

fromstring

tostring

subjectstring

textstring

htmlstring

rawMimestring

{
  "domainId": "string",
  "from": "string",
  "to": "string",
  "subject": "",
  "text": "string",
  "html": "string",
  "rawMime": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/inbound/simulate" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domainId":"string","from":"string","to":"string","subject":"","text":"string","html":"string","rawMime":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

202 Default Response

Example

{
  "matched": 0,
  "events": [
    {
      "id": "string",
      "routeId": "string",
      "status": "string",
      "attempts": 0,
      "lastError": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ]
}

Schema

matchedintegerrequired

eventsEventsItem[]required

Show child parameters

idstringrequired

routeIdstringrequired

statusstringrequired

attemptsintegerrequired

lastErrorstringrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · POST /v1/inbound/domains

5XX Default Response

Same as 4XX · POST /v1/inbound/domains

POSThttps://hermeticor.com/v1/transactional/parse

Parse a raw MIME message into from, to, subject, text, html, headers and attachment metadata (nothing is stored or sent)

Request body

application/json

rawMessagestringrequired

{
  "rawMessage": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/transactional/parse" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rawMessage":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "from": {
    "email": "string",
    "name": "string"
  },
  "to": [
    "string"
  ],
  "replyTo": "string",
  "subject": "string",
  "text": "string",
  "html": "string",
  "headers": {},
  "attachments": [
    {
      "filename": "string",
      "contentType": "string",
      "size": 0
    }
  ]
}

Schema

fromobjectrequired

Show child parameters

emailstringrequired

namestring

tostring[]required

replyTostringrequired

subjectstringrequired

textstringrequired

htmlstringrequired

headersobjectrequired

attachmentsobject[]required

Show child parameters

filenamestringrequired

contentTypestringrequired

sizeintegerrequired

4XX Default Response

Same as 4XX · POST /v1/inbound/domains

5XX Default Response

Same as 4XX · POST /v1/inbound/domains

GEThttps://hermeticor.com/v1/inbound/events

Parameters

routeIdstringquery

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "routeId": "string",
      "status": "string",
      "attempts": 0,
      "lastError": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsEventsItem[]required

Show child parameters

idstringrequired

routeIdstringrequired

statusstringrequired

attemptsintegerrequired

lastErrorstringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/inbound/domains

5XX Default Response

Same as 4XX · POST /v1/inbound/domains

Next part

Updated Nov 8, 2026

Was this page helpful?