pipelines

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-pipelines"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/da7694d5-c9d7-45df-8855-07506abc61b7/social-card.svg?v=3e7ae33eec8b" alt="pipelines" width="600" height="315"></a>
POSThttps://hermeticor.com/v1/pipelines/{type}

identify, track, page, screen, group or alias

Parameters

typestringpathrequired
identify | track | page | screen | group | alias

Request body

application/json
{}

Code samples

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

Responses

200 Default Response
Example
{
  "accepted": 0,
  "rejected": [
    {
      "index": 0,
      "reason": "string"
    }
  ]
}
Schema
acceptedintegerrequired
rejectedRejectedItem[]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/pipelines/{type}

POSThttps://hermeticor.com/v1/pipelines/posthog

PostHog capture-format events, batch or person export: events become track/page, persons and $identify become identify

Request body

application/json
Example
[
  {
    "event": "string",
    "distinct_id": "string",
    "properties": {},
    "timestamp": "string",
    "uuid": "string"
  }
]
PostV1PipelinesPosthogBodyVariant
eventstring
distinct_idstringrequired
propertiesobject
timestampstring
uuidstring
[
  {
    "event": "string",
    "distinct_id": "string",
    "properties": {},
    "timestamp": "string",
    "uuid": "string"
  }
]
Option 2
batchPostV1PipelinesPosthogBodyVariantItem[]required
Show child parameters
eventstring
distinct_idstringrequired
propertiesobject
timestampstring
uuidstring
{
  "batch": [
    {
      "event": "string",
      "distinct_id": "string",
      "properties": {},
      "timestamp": "string",
      "uuid": "string"
    }
  ]
}
PostV1PipelinesPosthogBodyVariantItem
eventstring
distinct_idstringrequired
propertiesobject
timestampstring
uuidstring
{
  "event": "string",
  "distinct_id": "string",
  "properties": {},
  "timestamp": "string",
  "uuid": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/pipelines/posthog" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '[{"event":"string","distinct_id":"string","properties":{},"timestamp":"string","uuid":"string"}]'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · POST /v1/pipelines/{type}

4XX Default Response

Same as 4XX · POST /v1/pipelines/{type}

5XX Default Response

Same as 4XX · POST /v1/pipelines/{type}

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

Mixed batch of identify/track/page/screen/group/alias calls; bad calls are rejected by index, the rest land

Request body

application/json
batchobject[]required
{
  "batch": [
    {}
  ]
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/pipelines/batch" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"batch":[{}]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · POST /v1/pipelines/{type}

4XX Default Response

Same as 4XX · POST /v1/pipelines/{type}

5XX Default Response

Same as 4XX · POST /v1/pipelines/{type}

POSThttps://hermeticor.com/v2/entity

Unified entity call for people and objects: identify, event, page, screen, delete, merge, add/delete relationships

Request body

application/json
typestringrequired
person | object
identifiersobjectrequired
Show child parameters
idstring
emailstring
phonestring
anonymousIdstring
objectTypestring
objectIdstring
actionstringrequired
identify | event | page | screen | delete | merge | add_relationships | delete_relationships
namestring
attributesobject
timestampstring
messageIdstring
primaryobject
Show child parameters
idstring
emailstring
phonestring
anonymousIdstring
objectTypestring
objectIdstring
relationshipsobject[]
Show child parameters
objectTypestringrequired
objectIdstringrequired
kindstring
{
  "type": "person",
  "identifiers": {
    "id": "string",
    "email": "string",
    "phone": "string",
    "anonymousId": "string",
    "objectType": "string",
    "objectId": "string"
  },
  "action": "identify",
  "name": "string",
  "attributes": {},
  "timestamp": "2024-01-01T00:00:00Z",
  "messageId": "string",
  "primary": {
    "id": "string",
    "email": "string",
    "phone": "string",
    "anonymousId": "string",
    "objectType": "string",
    "objectId": "string"
  },
  "relationships": [
    {
      "objectType": "string",
      "objectId": "string",
      "kind": "string"
    }
  ]
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v2/entity" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"person","identifiers":{"id":"string","email":"string","phone":"string","anonymousId":"string","objectType":"string","objectId":"string"},"action":"identify","name":"string","attributes":{},"timestamp":"2024-01-01T00:00:00Z","messageId":"string","primary":{"id":"string","email":"string","phone":"string","anonymousId":"string","objectType":"string","objectId":"string"},"relationships":[{"objectType":"string","objectId":"string","kind":"string"}]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

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

Same as 4XX · POST /v1/pipelines/{type}

5XX Default Response

Same as 4XX · POST /v1/pipelines/{type}

POSThttps://hermeticor.com/v2/batch

Request body

application/json
requestsobject[]required
{
  "requests": [
    {}
  ]
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v2/batch" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"requests":[{}]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · POST /v1/pipelines/{type}

4XX Default Response

Same as 4XX · POST /v1/pipelines/{type}

5XX Default Response

Same as 4XX · POST /v1/pipelines/{type}

POSThttps://hermeticor.com/v1/pipelines/rudderstack

RudderStack-format events (single or batch): use as a webhook destination in RudderStack

Request body

application/json
Example
{
  "batch": [
    {
      "type": "identify"
    }
  ]
}
Option 1
batchobject[]required
Show child parameters
typestringrequired
identify | track | page | screen | group | alias
{
  "batch": [
    {
      "type": "identify"
    }
  ]
}
Option 2
typestringrequired
identify | track | page | screen | group | alias
{
  "type": "identify"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/pipelines/rudderstack" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"batch":[{"type":"identify"}]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · POST /v1/pipelines/{type}

4XX Default Response

Same as 4XX · POST /v1/pipelines/{type}

5XX Default Response

Same as 4XX · POST /v1/pipelines/{type}

Updated