Fetch engage definitions for one or more engage IDs

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Get list of available engages

Request URL

https://{serverurl}/intelligence/sensors/api/getEngages

Scope

DesktopCentralCloud.Platform.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/engages.v1+jsonapplication/engages.v1+jsonCopied!

- Query Parameters

engageIDsstringOptional

Optional comma-separated engage IDs (e.g., 1001,1002). Omit to retrieve all engages

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/intelligence/sensors/api/getEngages \
  --header 'Accept: application/engages.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
namestring

Name of the engage

labelstring

Display label

descriptionstring

Description of what the engage does

questionsJSON Array

List of questions shown to the user

Show Sub-Attributes
JSON Object
Show Sub-Attributes
questionstring

Question text displayed to the user

optionsJSON Object

Map of option IDs to option labels (e.g., {'501': 'Yes', '502': 'Later'})

Show Sub-Attributes
defaultOptionstring

Default selected option label

typestring

Question type identifier

questionIDstring

Unique identifier of the question

senderInfoJSON Object

Sender details shown to the recipient

Show Sub-Attributes
namestring

Sender display name (e.g., 'IT Ops')

rolestring

Sender role (e.g., 'Administrator')

endMessagestring

Message shown after the user completes the engage

timeoutstring

Time limit in minutes for the user to respond

- HTTP code 500

Response Body - application/json
JSON Object
Hide Sub-Attributes
errorCodestring

Error code for the server error

errorMessagestring

Details about the error

Possible Response Codes

200HTTP code
500HTTP code

Sample Response: HTTP 200

Single engage definition with questions and sender info

Copied!
  {
    "1001": {
      "senderInfo": {
        "role": "Administrator",
        "name": "IT Ops"
      },
      "endMessage": "Thank you",
      "name": "Patch Feedback",
      "questions": [
        {
          "questionID": "9001",
          "question": "Can we reboot now?",
          "options": {
            "501": "Yes",
            "502": "Later"
          },
          "defaultOption": "Later",
          "type": 2
        }
      ],
      "description": "Collect user confirmation",
      "label": "Patch Prompt",
      "timeout": 30
    }
  }
                
Show full

Sample Response: HTTP 500

Server error while loading engages

Copied!
  {
    "errorMessage": "An internal error occurred while fetching engage details.",
    "errorCode": "INTERNAL_ERROR_WITH_CUSTOM_MSG"
  }
                
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.