Other endpoints

Embed

<a href="https://hermeticor.com/docs/ref-other-endpoints"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/9b8b485e-df2a-4959-8c16-36d30bd083b0/social-card.svg?v=3e7ae33eec8b" alt="Other endpoints" width="600" height="315"></a>

POSThttps://hermeticor.com/v1/event-definitions

Declare an event (and optionally its properties) before it is first sent

Request body

application/json

namestringrequired

schemaobject

{
  "name": "string",
  "schema": {}
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "name": "string",
  "category": "standard",
  "schema": {},
  "enforce": true,
  "goal": true,
  "firstSeenAt": "2024-01-01T00:00:00Z",
  "lastSeenAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

namestringrequired

categorystringrequired

standard | custom

schemaobjectrequired

enforcebooleanrequired

goalbooleanrequired

firstSeenAtstringrequired

lastSeenAtstringrequired

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/event-definitions

GEThttps://hermeticor.com/v1/event-definitions/{name}

Parameters

namestringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/event-definitions

4XX Default Response

Same as 4XX · POST /v1/event-definitions

5XX Default Response

Same as 4XX · POST /v1/event-definitions

DELETEhttps://hermeticor.com/v1/event-definitions/{name}

Remove the declaration only; stored events stay

Parameters

namestringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/event-definitions/{name}" \
  -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/event-definitions

5XX Default Response

Same as 4XX · POST /v1/event-definitions

PATCHhttps://hermeticor.com/v1/event-definitions/{name}

Parameters

namestringpathrequired

Request body

application/json

schemaobject

enforceboolean

goalboolean

{
  "schema": {},
  "enforce": true,
  "goal": true
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/event-definitions/{name}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"schema":{},"enforce":true,"goal":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/event-definitions

4XX Default Response

Same as 4XX · POST /v1/event-definitions

5XX Default Response

Same as 4XX · POST /v1/event-definitions

GEThttps://hermeticor.com/v1/event-definitions/{name}/usage

Journeys that start on this event

Parameters

namestringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/event-definitions/{name}/usage" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "workflows": [
    {
      "id": "string",
      "name": "string",
      "status": "string"
    }
  ]
}

Schema

workflowsobject[]required

Show child parameters

idstringrequired

namestringrequired

statusstringrequired

4XX Default Response

Same as 4XX · POST /v1/event-definitions

5XX Default Response

Same as 4XX · POST /v1/event-definitions

PUThttps://hermeticor.com/v1/event-definitions/{name}/properties/{prop}

Add or change one declared property type

Parameters

namestringpathrequired

propstringpathrequired

Request body

application/json

typestringrequired

string | number | boolean | object | array

{
  "type": "string"
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/event-definitions/{name}/properties/{prop}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/event-definitions

4XX Default Response

Same as 4XX · POST /v1/event-definitions

5XX Default Response

Same as 4XX · POST /v1/event-definitions

DELETEhttps://hermeticor.com/v1/event-definitions/{name}/properties/{prop}

Parameters

namestringpathrequired

propstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/event-definitions/{name}/properties/{prop}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/event-definitions

4XX Default Response

Same as 4XX · POST /v1/event-definitions

5XX Default Response

Same as 4XX · POST /v1/event-definitions

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

Parameters

limitintegerquery

= 50

cursorstringquery

namestringquery

goalstringquery

true | false

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "profileId": "string",
      "anonymousId": "string",
      "occurredAt": "2024-01-01T00:00:00Z",
      "source": "browser",
      "properties": {},
      "value": 0,
      "currency": "string",
      "metric": {
        "name": "string",
        "category": "string",
        "goal": true
      },
      "profile": {
        "id": "string",
        "email": "string",
        "firstName": "string",
        "lastName": "string"
      }
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem25[]required

Show child parameters

idstringrequired

namestringrequired

profileIdstringrequired

anonymousIdstringrequired

occurredAtstringrequired

sourcestringrequired

browser | server | integration | system

propertiesobjectrequired

valueintegerrequired

currencystringrequired

metricobject

Show child parameters

namestringrequired

categorystringrequired

goalbooleanrequired

profileobject

Show child parameters

idstringrequired

emailstringrequired

firstNamestringrequired

lastNamestringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/event-definitions

5XX Default Response

Same as 4XX · POST /v1/event-definitions

POSThttps://hermeticor.com/ingest/v1/batch

Request body

application/json

eventsobject[]required

consentobject

Show child parameters

analyticsboolean

marketingboolean

{
  "events": [
    {}
  ],
  "consent": {
    "analytics": true,
    "marketing": true
  }
}

Code samples

cURL

curl -X POST "https://hermeticor.com/ingest/v1/batch" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"events":[{}],"consent":{"analytics":true,"marketing":true}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "accepted": 0,
  "duplicates": 0,
  "rejected": [
    {
      "index": 0,
      "reason": "string"
    }
  ]
}

Schema

acceptedintegerrequired

duplicatesintegerrequired

rejectedRejectedItem[]required

Show child parameters

indexintegerrequired

reasonstringrequired

4XX Default Response

Same as 4XX · POST /v1/event-definitions

5XX Default Response

Same as 4XX · POST /v1/event-definitions

POSThttps://hermeticor.com/ingest/v1/identify

Request body

application/json

anonymousIdstringrequired

identifiersobjectrequired

Show child parameters

emailstring

phonestring

externalIdstring

traitsobject

consentobject

Show child parameters

analyticsboolean

marketingboolean

{
  "anonymousId": "string",
  "identifiers": {
    "email": "string",
    "phone": "string",
    "externalId": "string"
  },
  "traits": {},
  "consent": {
    "analytics": true,
    "marketing": true
  }
}

Code samples

cURL

curl -X POST "https://hermeticor.com/ingest/v1/identify" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"anonymousId":"string","identifiers":{"email":"string","phone":"string","externalId":"string"},"traits":{},"consent":{"analytics":true,"marketing":true}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "profileId": "string",
  "created": true
}

Schema

profileIdstringrequired

createdbooleanrequired

4XX Default Response

Same as 4XX · POST /v1/event-definitions

5XX Default Response

Same as 4XX · POST /v1/event-definitions

Next part

Updated Nov 8, 2026

Was this page helpful?