Application model

Details on every Application Object field
Written by Konstantine
Updated 1 month ago

Applications API allows you to get all your website widgets and apps.

Here's the example response for the Application API methods:

{
    "data": [
        {
            "id": 61,
            "name": "Demo iOS App",
            "displayName": "HelpCrunch iOS Demo";
            "active": true,
            "type": "ios"
        },
        {
            "id": 65,
            "name": "Demo Web App",
            "displayName": "HelpCrunch Demo";
            "active": false,
            "type": "web"
        },
        {
            "id": 70,
            "name": "Demo Android App",
            "displayName": "Android Demo";
            "active": true,
            "type": "android"
        },
        {
            "id": 71,
            "name": "17841453198752656",
            "displayName": "helpcrunch_family",
            "active": true,
            "type": "Instagram"
        },
        {
            "id": 74,
            "name": "573515439427574",
            "displayName": "HelpCrunch",
            "active": true,
            "type": "Facebook"
        },
        {
            "id": 77,
            "name": "17141453198750000",
            "displayName": "helpcrunch_team",
            "active": true,
            "type": "Instagram"
        },
        {
            "id": 79,
            "name": "pa:5752910518187380000",
            "displayName": "HelpCrunch",
            "active": true,
            "type": "Viber"
        }
    ]
}

Below you can find details on each of the Application Object fields.

Field Type Description
id Integer Unique id of the application provided by HelpCrunch
name String Application name
active Boolean

For web/iOS/Android:

  • true - application installed successfully
  • false - application not installed yet

For Facebook/Instagram/Telegram/Viber:

  • true - connected
  • true - disconnected
type String

"web" - website widget
"ios" - iOS SDK application
"android" - Android SDK application
"Facebook" - connected Facebook Page
"Telegram" - connected Telegram bot
"Viber" - connected Viber bot

If you have any questions regarding the REST API, feel free to chat us any time.

👩‍💻 Happy Coding! 👨‍💻

Did this answer your question?