workflows

Embed

<a href="https://hermeticor.com/docs/ref-workflows"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/27c987c7-83e1-4744-b0ce-54b59acc4526/social-card.svg?v=3e7ae33eec8b" alt="workflows" width="600" height="315"></a>

POSThttps://hermeticor.com/v1/workflows/templates/{key}

Parameters

keystringpathrequired

Request body

application/json

namestring

{
  "name": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/workflows/templates/{key}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "name": "string",
  "purpose": "marketing",
  "mode": "journey",
  "status": "draft",
  "publishedVersionId": "string",
  "folder": "string",
  "tags": [
    "string"
  ],
  "color": "string",
  "draftGraph": {},
  "draftTriggers": {},
  "draftSettings": {},
  "ab": {
    "variants": [
      {
        "versionId": "string",
        "weight": 0
      }
    ],
    "startedAt": "2024-01-01T00:00:00Z"
  },
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "install": {
    "templatesCreated": 0,
    "missingEvents": [
      "string"
    ],
    "todo": [
      "string"
    ]
  }
}

Schema

idstringrequired

namestringrequired

purposestringrequired

marketing | prospecting | transactional | operational

modestringrequired

journey | sequence

statusstringrequired

draft | live | paused | archived

publishedVersionIdstringrequired

folderstringrequired

tagsstring[]required

colorstring

draftGraphrequired

draftTriggersrequired

draftSettingsrequired

abobject

Show child parameters

variantsVariantsItem3[]required

Show child parameters

versionIdstringrequired

weightintegerrequired

startedAtstringrequired

createdAtstringrequired

updatedAtstringrequired

installobjectrequired

Show child parameters

templatesCreatedintegerrequired

missingEventsstring[]required

todostring[]required

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/workflows/templates/{key}

POSThttps://hermeticor.com/v1/workflows/batch/read

Read several workflows by id in one call

Request body

application/json

idsstring[]required

{
  "ids": [
    "string"
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/workflows/batch/read" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "purpose": "marketing",
      "mode": "journey",
      "status": "draft",
      "publishedVersionId": "string",
      "folder": "string",
      "tags": [
        "string"
      ],
      "color": "string",
      "draftGraph": {},
      "draftTriggers": {},
      "draftSettings": {},
      "ab": {
        "variants": [
          {
            "versionId": "string",
            "weight": 0
          }
        ],
        "startedAt": "2024-01-01T00:00:00Z"
      },
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ]
}

Schema

itemsItemsItem62[]required

Show child parameters

idstringrequired

namestringrequired

purposestringrequired

marketing | prospecting | transactional | operational

modestringrequired

journey | sequence

statusstringrequired

draft | live | paused | archived

publishedVersionIdstringrequired

folderstringrequired

tagsstring[]required

colorstring

draftGraphrequired

draftTriggersrequired

draftSettingsrequired

abobject

Show child parameters

variantsVariantsItem3[]required

startedAtstringrequired

createdAtstringrequired

updatedAtstringrequired

4XX Default Response

Same as 4XX · POST /v1/workflows/templates/{key}

5XX Default Response

Same as 4XX · POST /v1/workflows/templates/{key}

GEThttps://hermeticor.com/v1/workflows/emails

Every send step across live and paused journeys, with stats

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "workflowId": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

workflowIdstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/workflows/templates/{key}

5XX Default Response

Same as 4XX · POST /v1/workflows/templates/{key}

GEThttps://hermeticor.com/v1/profiles/{id}/workflows

Which journeys is this contact in (or has been in)

Parameters

limitintegerquery

= 50

cursorstringquery

statestringquery

livestringquery

true

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "enrollmentId": "string",
      "workflowId": "string",
      "workflowName": "string",
      "workflowStatus": "draft",
      "state": "active",
      "currentNodeId": "string",
      "enteredAt": "2024-01-01T00:00:00Z",
      "exitedAt": "2024-01-01T00:00:00Z",
      "exitedReason": "string",
      "goalReachedAt": "2024-01-01T00:00:00Z",
      "triggerType": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

enrollmentIdstringrequired

workflowIdstringrequired

workflowNamestringrequired

workflowStatusstringrequired

draft | live | paused | archived

statestringrequired

currentNodeIdstringrequired

enteredAtstringrequired

exitedAtstringrequired

exitedReasonstringrequired

goalReachedAtstringrequired

triggerTypestringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/workflows/templates/{key}

5XX Default Response

Same as 4XX · POST /v1/workflows/templates/{key}

GEThttps://hermeticor.com/v1/workflows/{id}/enrollments/{enrollmentId}/steps

The step trail of one enrollment

Parameters

limitintegerquery

= 50

cursorstringquery

idstringpathrequired

enrollmentIdstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/workflows/{id}/enrollments/{enrollmentId}/steps" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "nodeId": "string",
      "stepSeq": 0,
      "kind": "string",
      "handle": "string",
      "note": "string",
      "at": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

nodeIdstringrequired

stepSeqintegerrequired

kindstringrequired

handlestringrequired

notestringrequired

atstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/workflows/templates/{key}

5XX Default Response

Same as 4XX · POST /v1/workflows/templates/{key}

Next part

Updated Nov 8, 2026

Was this page helpful?