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/{id}/enrollments/exit-all

Remove everyone still inside the journey (or only those at one step); up to 500 per call, `more` says to repeat

Parameters

idstringpathrequired

Request body

application/json

nodeIdstring

{
  "nodeId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/workflows/{id}/enrollments/exit-all" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"nodeId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "exited": 0,
  "more": true
}

Schema

exitedintegerrequired

morebooleanrequired

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/{id}/enrollments/exit-all

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

Parameters

idstringpathrequired

enrollmentIdstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/workflows/{id}/enrollments/{enrollmentId}" \
  -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/workflows/{id}/enrollments/exit-all

5XX Default Response

Same as 4XX · POST /v1/workflows/{id}/enrollments/exit-all

POSThttps://hermeticor.com/v1/workflows/{id}/enrollments/{enrollmentId}/jump

Parameters

idstringpathrequired

enrollmentIdstringpathrequired

Request body

application/json

nodeIdstringrequired

{
  "nodeId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/workflows/{id}/enrollments/{enrollmentId}/jump" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"nodeId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/workflows/{id}/enrollments/{enrollmentId}

4XX Default Response

Same as 4XX · POST /v1/workflows/{id}/enrollments/exit-all

5XX Default Response

Same as 4XX · POST /v1/workflows/{id}/enrollments/exit-all

POSThttps://hermeticor.com/v1/workflows/{id}/enrollments/{enrollmentId}/reschedule

Change when a waiting person wakes up (a delay, or the timeout of an event wait)

Parameters

idstringpathrequired

enrollmentIdstringpathrequired

Request body

application/json

runAtstringrequired

{
  "runAt": "2024-01-01T00:00:00Z"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/workflows/{id}/enrollments/{enrollmentId}/reschedule" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"runAt":"2024-01-01T00:00:00Z"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/workflows/{id}/enrollments/{enrollmentId}

4XX Default Response

Same as 4XX · POST /v1/workflows/{id}/enrollments/exit-all

5XX Default Response

Same as 4XX · POST /v1/workflows/{id}/enrollments/exit-all

POSThttps://hermeticor.com/v1/workflows/{id}/migrate

Parameters

idstringpathrequired

Request body

application/json

fromVersionIdstringrequired

toVersionIdstringrequired

nodeMapobject

= {}

{
  "fromVersionId": "string",
  "toVersionId": "string",
  "nodeMap": {}
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/workflows/{id}/migrate" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fromVersionId":"string","toVersionId":"string","nodeMap":{}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "moved": 0,
  "exitedUnmapped": 0
}

Schema

movedintegerrequired

exitedUnmappedintegerrequired

4XX Default Response

Same as 4XX · POST /v1/workflows/{id}/enrollments/exit-all

5XX Default Response

Same as 4XX · POST /v1/workflows/{id}/enrollments/exit-all

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

Send steps of a journey with stats, queue size and pause state

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "nodeId": "string",
      "type": "string",
      "config": {},
      "status": "live",
      "pauseMode": "wait",
      "entered": 0,
      "completed": 0,
      "errors": 0,
      "queued": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem64[]required

Show child parameters

nodeIdstringrequired

typestringrequired

configrequired

statusstringrequired

live | paused

pauseModestringrequired

wait | skip | review

enteredintegerrequired

completedintegerrequired

errorsintegerrequired

queuedintegerrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/workflows/{id}/enrollments/exit-all

5XX Default Response

Same as 4XX · POST /v1/workflows/{id}/enrollments/exit-all

GEThttps://hermeticor.com/v1/workflows/{id}/nodes/{nodeId}

Parameters

idstringpathrequired

nodeIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "nodeId": "string",
  "type": "string",
  "config": {},
  "status": "live",
  "pauseMode": "wait",
  "entered": 0,
  "completed": 0,
  "errors": 0,
  "queued": 0
}

Schema

nodeIdstringrequired

typestringrequired

configrequired

statusstringrequired

live | paused

pauseModestringrequired

wait | skip | review

enteredintegerrequired

completedintegerrequired

errorsintegerrequired

queuedintegerrequired

4XX Default Response

Same as 4XX · POST /v1/workflows/{id}/enrollments/exit-all

5XX Default Response

Same as 4XX · POST /v1/workflows/{id}/enrollments/exit-all

DELETEhttps://hermeticor.com/v1/workflows/{id}/nodes/{nodeId}

Delete a step of a running journey; people waiting at it continue to the next step or leave

Parameters

applystringquery

new_entrants | waiting = new_entrants

waitingstringquery

move_on | exit = move_on

idstringpathrequired

nodeIdstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "version": {
    "id": "string",
    "workflowId": "string",
    "n": 0,
    "graph": {},
    "trigger": {},
    "settings": {},
    "checksum": "string",
    "publishedAt": "2024-01-01T00:00:00Z",
    "publishedBy": "string"
  },
  "moved": 0,
  "exited": 0
}

Schema

versionobjectrequired

Show child parameters

idstringrequired

workflowIdstringrequired

nintegerrequired

graphrequired

triggerrequired

settingsrequired

checksumstringrequired

publishedAtstringrequired

publishedBystringrequired

movedintegerrequired

exitedintegerrequired

4XX Default Response

Same as 4XX · POST /v1/workflows/{id}/enrollments/exit-all

5XX Default Response

Same as 4XX · POST /v1/workflows/{id}/enrollments/exit-all

PATCHhttps://hermeticor.com/v1/workflows/{id}/nodes/{nodeId}

Set a step live or paused (applies to a running journey)

Parameters

idstringpathrequired

nodeIdstringpathrequired

Request body

application/json

statusstringrequired

live | paused

modestring

wait | skip | review = wait

{
  "status": "live",
  "mode": "wait"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/workflows/{id}/nodes/{nodeId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"live","mode":"wait"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/workflows/{id}/nodes/{nodeId}

4XX Default Response

Same as 4XX · POST /v1/workflows/{id}/enrollments/exit-all

5XX Default Response

Same as 4XX · POST /v1/workflows/{id}/enrollments/exit-all

Next part

Updated Nov 8, 2026

Was this page helpful?