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>
POSThttps://hermeticor.com/v1/workflow-custom-types

Register an action type (runs a call template or code action) or a trigger type (fires on an event)

Request body

application/json
kindstringrequired
action | trigger
keystringrequired
namestringrequired
descriptionstring
fieldsFieldsItem6[]
= []
Show child parameters
keystringrequired
labelstringrequired
typestring
string | number | boolean | date | enum = string
requiredboolean
= false
optionsstring[]
webhookTemplateIdstring
eventNamestring
{
  "kind": "action",
  "key": "string",
  "name": "string",
  "description": "",
  "fields": [],
  "webhookTemplateId": "string",
  "eventName": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/workflow-custom-types" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"action","key":"string","name":"string","description":"","fields":[],"webhookTemplateId":"string","eventName":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "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"
}
Schema
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
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/workflow-custom-types

GEThttps://hermeticor.com/v1/workflow-custom-types/{id}

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response

Same as 201 · POST /v1/workflow-custom-types

4XX Default Response

Same as 4XX · POST /v1/workflow-custom-types

5XX Default Response

Same as 4XX · POST /v1/workflow-custom-types

DELETEhttps://hermeticor.com/v1/workflow-custom-types/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/workflow-custom-types/{id}" \
  -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 · POST /v1/workflow-custom-types

5XX Default Response

Same as 4XX · POST /v1/workflow-custom-types

PATCHhttps://hermeticor.com/v1/workflow-custom-types/{id}

Rename, change fields, or archive (archived types leave the palette but keep running)

Parameters

idstringpathrequired

Request body

application/json
namestring
descriptionstring
fieldsFieldsItem6[]
Show child parameters
keystringrequired
labelstringrequired
typestring
string | number | boolean | date | enum = string
requiredboolean
= false
optionsstring[]
webhookTemplateIdstring
eventNamestring
archivedboolean
{
  "name": "string",
  "description": "string",
  "fields": [
    {
      "key": "string",
      "label": "string",
      "type": "string",
      "required": false,
      "options": [
        "string"
      ]
    }
  ],
  "webhookTemplateId": "string",
  "eventName": "string",
  "archived": true
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/workflow-custom-types/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","description":"string","fields":[{"key":"string","label":"string","type":"string","required":false,"options":["string"]}],"webhookTemplateId":"string","eventName":"string","archived":true}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/workflow-custom-types

4XX Default Response

Same as 4XX · POST /v1/workflow-custom-types

5XX Default Response

Same as 4XX · POST /v1/workflow-custom-types

Updated