inapp-client

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-inapp-client"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/7cbe109c-c379-475e-80db-4ca38c773f66/social-card.svg?v=3e7ae33eec8b" alt="inapp-client" width="600" height="315"></a>
POSThttps://hermeticor.com/client/in-app-trackers/{id}/events

The component reports an event; the journey waiting on it moves on

Parameters

company_idstringquery
external_idstringquery
emailstringquery
phone_numberstringquery
anonymous_idstringquery
idstringpathrequired

Request body

application/json
eventstringrequired
profileobjectrequired
Show child parameters
externalIdstring
emailstring
phoneNumberstring
anonymousIdstring
{
  "event": "string",
  "profile": {
    "externalId": "string",
    "email": "string",
    "phoneNumber": "string",
    "anonymousId": "string"
  }
}

Code samples

cURL
curl -X POST "https://hermeticor.com/client/in-app-trackers/{id}/events" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"event":"string","profile":{"externalId":"string","email":"string","phoneNumber":"string","anonymousId":"string"}}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

202 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
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 /client/in-app-trackers/{id}/events

POSThttps://hermeticor.com/client/geofence-events

The app entered, left or dwelled in a geofence: recorded as geofence_entered / geofence_exited / geofence_dwelled

Parameters

company_idstringquery
external_idstringquery
emailstringquery
phone_numberstringquery
anonymous_idstringquery

Request body

application/json
geofenceIdstringrequired
transitionstring
enter | exit | dwell = enter
profileobjectrequired
Show child parameters
externalIdstring
emailstring
phoneNumberstring
anonymousIdstring
{
  "geofenceId": "string",
  "transition": "enter",
  "profile": {
    "externalId": "string",
    "email": "string",
    "phoneNumber": "string",
    "anonymousId": "string"
  }
}

Code samples

cURL
curl -X POST "https://hermeticor.com/client/geofence-events" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"geofenceId":"string","transition":"enter","profile":{"externalId":"string","email":"string","phoneNumber":"string","anonymousId":"string"}}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

202 Default Response
Example
{
  "ok": true,
  "recorded": 0
}
Schema
okbooleanrequired
true
recordedintegerrequired
4XX Default Response

Same as 4XX · POST /client/in-app-trackers/{id}/events

5XX Default Response

Same as 4XX · POST /client/in-app-trackers/{id}/events

Updated