Endpoints

Embed

<a href="https://hermeticor.com/docs/ref-endpoints"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/30cd59e5-acb1-4277-a050-481f9f4dc46f/social-card.svg?v=3e7ae33eec8b" alt="Endpoints" width="600" height="315"></a>

POSThttps://hermetica.15.204.158.166.sslip.io/v1/events

Request body

application/json

namestringrequired

occurredAtstring

propertiesobject

valueinteger

amountnumber

currencystring

dedupeKeystring

profileobject

Show child parameters

emailstring

phonestring

externalIdstring

firstNamestring

lastNamestring

localestring

locationobject

Show child parameters

citystring

regionstring

countrystring

zipstring

address1string

latitudenumber

longitudenumber

timezonestring

attributesobject

correlationKeystring

correlationValuestring | number

anonymousIdstring

contextobject

Show child parameters

pageobject

Show child parameters

urlstring

referrerstring

titlestring

userAgentstring

ipstring

utmobject

{
  "name": "string",
  "occurredAt": "2024-01-01T00:00:00Z",
  "properties": {},
  "value": 0,
  "amount": 0,
  "currency": "string",
  "dedupeKey": "string",
  "profile": {
    "email": "string",
    "phone": "string",
    "externalId": "string",
    "firstName": "string",
    "lastName": "string",
    "locale": "string",
    "location": {
      "city": "string",
      "region": "string",
      "country": "string",
      "zip": "string",
      "address1": "string",
      "latitude": 0,
      "longitude": 0,
      "timezone": "string"
    },
    "attributes": {}
  },
  "correlationKey": "string",
  "correlationValue": "string",
  "anonymousId": "string",
  "context": {
    "page": {
      "url": "string",
      "referrer": "string",
      "title": "string"
    },
    "userAgent": "string",
    "ip": "string",
    "utm": {}
  }
}

Code samples

cURL

curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/events" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","occurredAt":"2024-01-01T00:00:00Z","properties":{},"value":0,"amount":0,"currency":"string","dedupeKey":"string","profile":{"email":"string","phone":"string","externalId":"string","firstName":"string","lastName":"string","locale":"string","location":{"city":"string","region":"string","country":"string","zip":"string","address1":"string","latitude":0,"longitude":0,"timezone":"string"},"attributes":{}},"correlationKey":"string","correlationValue":"string","anonymousId":"string","context":{"page":{"url":"string","referrer":"string","title":"string"},"userAgent":"string","ip":"string","utm":{}}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

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

Schema

acceptedintegerrequired

duplicatesintegerrequired

rejectedobject[]required

Show child parameters

indexintegerrequired

reasonstringrequired

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

POSThttps://hermetica.15.204.158.166.sslip.io/v1/events/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://hermetica.15.204.158.166.sslip.io/v1/events/batch" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"events":[{}],"consent":{"analytics":true,"marketing":true}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/events

4XX Default Response

Same as 4XX · POST /v1/events

5XX Default Response

Same as 4XX · POST /v1/events

POSThttps://hermetica.15.204.158.166.sslip.io/v1/events/batch/items

Same as /v1/events/batch, plus a status for every submitted event by position (a duplicate counts as stored: it was already there)

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://hermetica.15.204.158.166.sslip.io/v1/events/batch/items" \
  -H "Authorization: Bearer $SSLIP_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"
    }
  ],
  "items": [
    {
      "index": 0,
      "status": "stored",
      "reason": "string"
    }
  ]
}

Schema

acceptedintegerrequired

duplicatesintegerrequired

rejectedobject[]required

Show child parameters

indexintegerrequired

reasonstringrequired

itemsobject[]required

Show child parameters

indexintegerrequired

statusstringrequired

stored | rejected

reasonstring

4XX Default Response

Same as 4XX · POST /v1/events

5XX Default Response

Same as 4XX · POST /v1/events

POSThttps://hermetica.15.204.158.166.sslip.io/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://hermetica.15.204.158.166.sslip.io/v1/identify" \
  -H "Authorization: Bearer $SSLIP_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/events

5XX Default Response

Same as 4XX · POST /v1/events

GEThttps://hermetica.15.204.158.166.sslip.io/v1/events/settings

Whether server-side event ingest is on, and the custom field used as each person's primary key

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/events/settings" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "serverIngestEnabled": true,
  "primaryKeyAttribute": "string"
}

Schema

serverIngestEnabledbooleanrequired

primaryKeyAttributestringrequired

4XX Default Response

Same as 4XX · POST /v1/events

5XX Default Response

Same as 4XX · POST /v1/events

PUThttps://hermetica.15.204.158.166.sslip.io/v1/events/settings

Turn server-side event ingest on or off (callers get 412 while off, nothing is dropped silently), or set the primary-key field

Request body

application/json

serverIngestEnabledboolean

primaryKeyAttributestring

{
  "serverIngestEnabled": true,
  "primaryKeyAttribute": "string"
}

Code samples

cURL

curl -X PUT "https://hermetica.15.204.158.166.sslip.io/v1/events/settings" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"serverIngestEnabled":true,"primaryKeyAttribute":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/events/settings

4XX Default Response

Same as 4XX · POST /v1/events

5XX Default Response

Same as 4XX · POST /v1/events

GEThttps://hermetica.15.204.158.166.sslip.io/v1/event-definitions

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/event-definitions" \
  -H "Authorization: Bearer $SSLIP_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

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

Schema

itemsobject[]required

Show child parameters

idstringrequired

namestringrequired

categorystringrequired

standard | custom

schemaobjectrequired

enforcebooleanrequired

goalbooleanrequired

firstSeenAtstringrequired

lastSeenAtstringrequired

4XX Default Response

Same as 4XX · POST /v1/events

5XX Default Response

Same as 4XX · POST /v1/events

POSThttps://hermetica.15.204.158.166.sslip.io/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://hermetica.15.204.158.166.sslip.io/v1/event-definitions" \
  -H "Authorization: Bearer $SSLIP_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

Same as 4XX · POST /v1/events

5XX Default Response

Same as 4XX · POST /v1/events

GEThttps://hermetica.15.204.158.166.sslip.io/v1/event-definitions/{name}

Parameters

namestringpathrequired

Code samples

cURL

curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/event-definitions/{name}" \
  -H "Authorization: Bearer $SSLIP_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/events

5XX Default Response

Same as 4XX · POST /v1/events

Next part

Updated Nov 2, 2026

Was this page helpful?