inapp

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-inapp"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/13f172cc-45a0-4cc5-8cb7-3f7955ce3df0/social-card.svg?v=3e7ae33eec8b" alt="inapp" width="600" height="315"></a>
GEThttps://hermeticor.com/v1/in-app-components

Developer-defined in-app components

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/in-app-components" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "key": "string",
      "name": "string",
      "description": "string",
      "fields": [
        {
          "key": "string",
          "label": "string",
          "type": "text",
          "required": false
        }
      ],
      "events": [
        "string"
      ],
      "createdAt": "string"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem209[]required
Show child parameters
idstringrequired
keystringrequired
namestringrequired
descriptionstringrequired
fieldsFieldsItem2[]required
Show child parameters
keystringrequired
labelstringrequired
typestringrequired
text | number | boolean | url | image
requiredbooleanrequired
= false
eventsstring[]required
createdAtstringrequired
nextCursorstringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /v1/in-app-components

POSThttps://hermeticor.com/v1/in-app-components

Define a component the app renders natively (its fields and the events it reports)

Request body

application/json
keystringrequired
namestringrequired
descriptionstring
fieldsFieldsItem3[]
= []
Show child parameters
keystringrequired
labelstringrequired
typestringrequired
text | number | boolean | url | image
requiredboolean
= false
eventsstring[]
= []
{
  "key": "string",
  "name": "string",
  "description": "",
  "fields": [],
  "events": []
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/in-app-components" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"key":"string","name":"string","description":"","fields":[],"events":[]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "key": "string",
  "name": "string",
  "description": "string",
  "fields": [
    {
      "key": "string",
      "label": "string",
      "type": "text",
      "required": false
    }
  ],
  "events": [
    "string"
  ],
  "createdAt": "string"
}
Schema
idstringrequired
keystringrequired
namestringrequired
descriptionstringrequired
fieldsFieldsItem2[]required
Show child parameters
keystringrequired
labelstringrequired
typestringrequired
text | number | boolean | url | image
requiredbooleanrequired
= false
eventsstring[]required
createdAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/in-app-components

5XX Default Response

Same as 4XX · GET /v1/in-app-components

DELETEhttps://hermeticor.com/v1/in-app-components/{id}

Delete a component

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/in-app-components/{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 · GET /v1/in-app-components

5XX Default Response

Same as 4XX · GET /v1/in-app-components

PATCHhttps://hermeticor.com/v1/in-app-components/{id}

Edit a component

Parameters

idstringpathrequired

Request body

application/json
namestring
descriptionstring
fieldsFieldsItem3[]
Show child parameters
keystringrequired
labelstringrequired
typestringrequired
text | number | boolean | url | image
requiredboolean
= false
eventsstring[]
{
  "name": "string",
  "description": "string",
  "fields": [
    {
      "key": "string",
      "label": "string",
      "type": "text",
      "required": false
    }
  ],
  "events": [
    "string"
  ]
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/in-app-components/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","description":"string","fields":[{"key":"string","label":"string","type":"text","required":false}],"events":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/in-app-components

4XX Default Response

Same as 4XX · GET /v1/in-app-components

5XX Default Response

Same as 4XX · GET /v1/in-app-components

Updated