workflows

Embed
Preview of the card
<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/workflows/{id}/nodes/{nodeId}/queue/{profileId}

Parameters

idstringpathrequired
nodeIdstringpathrequired
profileIdstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/workflows/{id}/nodes/{nodeId}/queue/{profileId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "id": "string",
  "stuckReason": "schedule_lost",
  "profileEmail": "string",
  "lastError": "string"
}
Schema
idstringrequired
stuckReasonstring
schedule_lost | overdue | failed | paused | awaiting_signal
profileEmailstring
lastErrorstring
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/workflows/{id}/nodes/{nodeId}/queue/{profileId}

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

Parameters

idstringpathrequired
nodeIdstringpathrequired
profileIdstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/workflows/{id}/nodes/{nodeId}/queue/{profileId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response

Same as 4XX · GET /v1/workflows/{id}/nodes/{nodeId}/queue/{profileId}

5XX Default Response

Same as 4XX · GET /v1/workflows/{id}/nodes/{nodeId}/queue/{profileId}

GEThttps://hermeticor.com/v1/workflows/{id}/removed-subscribers

Parameters

limitintegerquery
= 50
cursorstringquery
profileIdstringquery
emailstringquery
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/workflows/{id}/removed-subscribers" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "stuckReason": "schedule_lost",
      "profileEmail": "string",
      "lastError": "string"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem63[]required
Show child parameters
idstringrequired
stuckReasonstring
schedule_lost | overdue | failed | paused | awaiting_signal
profileEmailstring
lastErrorstring
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/workflows/{id}/nodes/{nodeId}/queue/{profileId}

5XX Default Response

Same as 4XX · GET /v1/workflows/{id}/nodes/{nodeId}/queue/{profileId}

POSThttps://hermeticor.com/v1/workflows/{id}/removed-subscribers

Remove a subscriber from the journey

Parameters

idstringpathrequired

Request body

application/json
profileIdstringrequired
{
  "profileId": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/workflows/{id}/removed-subscribers" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"profileId":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · DELETE /v1/workflows/{id}/nodes/{nodeId}/queue/{profileId}

4XX Default Response

Same as 4XX · GET /v1/workflows/{id}/nodes/{nodeId}/queue/{profileId}

5XX Default Response

Same as 4XX · GET /v1/workflows/{id}/nodes/{nodeId}/queue/{profileId}

GEThttps://hermeticor.com/v1/workflows/{id}/removed-subscribers/{profileId}

Parameters

idstringpathrequired
profileIdstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/workflows/{id}/removed-subscribers/{profileId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

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

4XX Default Response

Same as 4XX · GET /v1/workflows/{id}/nodes/{nodeId}/queue/{profileId}

5XX Default Response

Same as 4XX · GET /v1/workflows/{id}/nodes/{nodeId}/queue/{profileId}

GEThttps://hermeticor.com/v1/workflows/goal-completions

Everyone who reached a journey goal, across journeys

Parameters

limitintegerquery
= 50
cursorstringquery
workflowIdstringquery
profileIdstringquery
sincestringquery

Code samples

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "enrollmentId": "string",
      "workflowId": "string",
      "workflowName": "string",
      "profileId": "string",
      "profileEmail": "string",
      "reachedAt": "2024-01-01T00:00:00Z",
      "enteredAt": "2024-01-01T00:00:00Z",
      "endedBy": "string",
      "state": "string",
      "appliedTags": [],
      "appliedListIds": []
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
enrollmentIdstringrequired
workflowIdstringrequired
workflowNamestringrequired
profileIdstringrequired
profileEmailstringrequired
reachedAtstringrequired
enteredAtstringrequired
endedBystringrequired
statestringrequired
appliedTagsstring[]required
= []
appliedListIdsstring[]required
= []
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/workflows/{id}/nodes/{nodeId}/queue/{profileId}

5XX Default Response

Same as 4XX · GET /v1/workflows/{id}/nodes/{nodeId}/queue/{profileId}

GEThttps://hermeticor.com/v1/workflows/activity-log

Flat step log across journeys, filterable by journey, contact, step and kind

Parameters

limitintegerquery
= 50
cursorstringquery
workflowIdstringquery
profileIdstringquery
sincestringquery
kindstringquery
entered | completed | branched | waiting | resumed | skipped | error | exited
nodeIdstringquery

Code samples

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "enrollmentId": "string",
      "workflowId": "string",
      "workflowName": "string",
      "profileId": "string",
      "profileEmail": "string",
      "nodeId": "string",
      "kind": "string",
      "handle": "string",
      "note": "string",
      "at": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
enrollmentIdstringrequired
workflowIdstringrequired
workflowNamestringrequired
profileIdstringrequired
profileEmailstringrequired
nodeIdstringrequired
kindstringrequired
handlestringrequired
notestringrequired
atstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/workflows/{id}/nodes/{nodeId}/queue/{profileId}

5XX Default Response

Same as 4XX · GET /v1/workflows/{id}/nodes/{nodeId}/queue/{profileId}

POSThttps://hermeticor.com/v1/workflows/bulk-edit

Archive, pause, tag or move several journeys at once

Request body

application/json
idsstring[]required
actionstringrequired
archive | pause | add_tags | remove_tags | set_folder
tagsstring[]
folderstring
{
  "ids": [
    "string"
  ],
  "action": "archive",
  "tags": [
    "string"
  ],
  "folder": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/workflows/bulk-edit" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"],"action":"archive","tags":["string"],"folder":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "done": 0,
  "failed": [
    {
      "id": "string",
      "reason": "string"
    }
  ]
}
Schema
doneintegerrequired
failedFailedItem[]required
Show child parameters
idstringrequired
reasonstringrequired
4XX Default Response

Same as 4XX · GET /v1/workflows/{id}/nodes/{nodeId}/queue/{profileId}

5XX Default Response

Same as 4XX · GET /v1/workflows/{id}/nodes/{nodeId}/queue/{profileId}

Updated