Faqprime Widget Info API?

API Type



API Purpose 

   To get the Widget Info set in the widget Admin Section. 

API Format

    <Helpdesk URL>/api/widget-info?keysecret=<Key Secret>




API Response 

  • error: true if there is an error in API and false if API is successful.

  • reason: Error Reason, present only if error is true.

    • Possible Reasons:

      • keysecret is missing

      • keysecret is not matching

      • text is missing

      • text length should be atleast 4
  • time: Current Time in Unix Time format.

  • vcount: Number of variables returned in the response.

  • ccount: Number of contexts returned in the response.

  • tintentcount: Number of Timer Intents returned in the response.

  • disablecount: Number of disables returned in the response.

  • variables: List of Variables.
  • contexts: List of contexts defined in context control.
  • tintents: List of timer intents defined in custom trigger. 
  • disables: List of disables defined in visibility control. 
Did this answer your question?