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>

GEThttps://hermeticor.com/v1/goals

Every goal of every journey (flow goals and goal steps) with its conversion figures

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "workflowId": "string",
      "workflowName": "string",
      "nodeId": "string",
      "kind": "flow",
      "name": "string",
      "match": {},
      "tags": [
        "string"
      ],
      "listIds": [
        "string"
      ],
      "enrolled": 0,
      "converted": 0,
      "rate": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem183[]required

Show child parameters

idstringrequired

workflowIdstringrequired

workflowNamestringrequired

nodeIdstringrequired

kindstringrequired

flow | step

namestringrequired

matchrequired

tagsstring[]required

listIdsstring[]required

enrollednumberrequired

convertednumberrequired

ratenumberrequired

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/goals

GEThttps://hermeticor.com/v1/goals/stats

Totals across goals and the best performers

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "goals": 0,
  "enrolled": 0,
  "converted": 0,
  "rate": 0,
  "top": [
    {
      "id": "string",
      "workflowId": "string",
      "workflowName": "string",
      "nodeId": "string",
      "kind": "flow",
      "name": "string",
      "match": {},
      "tags": [
        "string"
      ],
      "listIds": [
        "string"
      ],
      "enrolled": 0,
      "converted": 0,
      "rate": 0
    }
  ]
}

Schema

goalsnumberrequired

enrollednumberrequired

convertednumberrequired

ratenumberrequired

topItemsItem183[]required

Show child parameters

idstringrequired

workflowIdstringrequired

workflowNamestringrequired

nodeIdstringrequired

kindstringrequired

flow | step

namestringrequired

matchrequired

tagsstring[]required

listIdsstring[]required

enrollednumberrequired

convertednumberrequired

ratenumberrequired

4XX Default Response

Same as 4XX · GET /v1/goals

5XX Default Response

Same as 4XX · GET /v1/goals

GEThttps://hermeticor.com/v1/goals/{goalId}

Parameters

goalIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "workflowId": "string",
  "workflowName": "string",
  "nodeId": "string",
  "kind": "flow",
  "name": "string",
  "match": {},
  "tags": [
    "string"
  ],
  "listIds": [
    "string"
  ],
  "enrolled": 0,
  "converted": 0,
  "rate": 0
}

Schema

idstringrequired

workflowIdstringrequired

workflowNamestringrequired

nodeIdstringrequired

kindstringrequired

flow | step

namestringrequired

matchrequired

tagsstring[]required

listIdsstring[]required

enrollednumberrequired

convertednumberrequired

ratenumberrequired

4XX Default Response

Same as 4XX · GET /v1/goals

5XX Default Response

Same as 4XX · GET /v1/goals

GEThttps://hermeticor.com/v1/goals/{goalId}/tags

Tags the journey adds right after this goal

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

goalIdstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/goals/{goalId}/tags" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

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

Schema

itemsstring[]required

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/goals

5XX Default Response

Same as 4XX · GET /v1/goals

GEThttps://hermeticor.com/v1/goals/{goalId}/lists

Lists the journey adds people to right after this goal

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

goalIdstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/goals/{goalId}/lists" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/goals/{goalId}/tags

4XX Default Response

Same as 4XX · GET /v1/goals

5XX Default Response

Same as 4XX · GET /v1/goals

GEThttps://hermeticor.com/v1/workflows/{id}/entry-skips

People who could not enter (journey not live, outside its window, no start step, profile gone, cap reached), newest first

Parameters

limitintegerquery

= 50

cursorstringquery

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "workflowId": "string",
      "profileId": "string",
      "reason": "string",
      "triggerType": "string",
      "at": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

workflowIdstringrequired

profileIdstringrequired

reasonstringrequired

triggerTypestringrequired

atstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/goals

5XX Default Response

Same as 4XX · GET /v1/goals

POSThttps://hermeticor.com/v1/workflows/{id}/enroll-object-segment

Enroll the people linked to each object in an object segment (the object rides along as the trigger event)

Parameters

idstringpathrequired

Request body

application/json

segmentIdstringrequired

{
  "segmentId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/workflows/{id}/enroll-object-segment" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"segmentId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "enrolled": 0,
  "skipped": [
    {
      "profileId": "string",
      "reason": "string"
    }
  ],
  "queued": true
}

Schema

enrolledintegerrequired

skippedSkippedItem[]required

Show child parameters

profileIdstringrequired

reasonstringrequired

queuedboolean

4XX Default Response

Same as 4XX · GET /v1/goals

5XX Default Response

Same as 4XX · GET /v1/goals

GEThttps://hermeticor.com/v1/workflow-custom-types

The workspace's own action and trigger types (palette and trigger picker)

Parameters

kindstringquery

action | trigger

archivedstringquery

true | false

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "kind": "action",
      "key": "string",
      "name": "string",
      "description": "string",
      "fields": [
        {
          "key": "string",
          "label": "string",
          "type": "string",
          "required": false,
          "options": [
            "string"
          ]
        }
      ],
      "webhookTemplateId": "string",
      "eventName": "string",
      "archivedAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem245[]required

Show child parameters

idstringrequired

kindstringrequired

action | trigger

keystringrequired

namestringrequired

descriptionstringrequired

fieldsFieldsItem5[]required

Show child parameters

keystringrequired

labelstringrequired

typestringrequired

string | number | boolean | date | enum = string

requiredbooleanrequired

= false

optionsstring[]

webhookTemplateIdstringrequired

eventNamestringrequired

archivedAtstringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/goals

5XX Default Response

Same as 4XX · GET /v1/goals

Next part

Updated Nov 8, 2026

Was this page helpful?