Documentation

Response Payload

The payload your app sends to HelpSpace


Send Raw JSON content

If you send a basic JSON object, then we just render all of its data automatically.

{
  "website": "https://test.com",
  "subscription": "Basic Plan",
  "has_active_trial": true,
  "onboardin_status": "50%"
  ...
}

Send Raw HTML content

If you just send a single html key with raw (escaped) HTML as the value, we will just take that HTML and render it inside the sidebar. This way you have full control of how the data should look like.

{
  "html": '<a href=\"https://test.com\">Test Link<\/a>'
}