viaSocket Help

Help

A Help field shows the additional information as a Note.

Static and Dynamic Help.

  • Supported formats: Text, HTML, and Markdown.

  • Common use-cases: Field guidance, error or warning messages, and resource status updates.

Add field → Help → Configure options type Static or Dynamic

#

Static

It uses the help attribute to display fixed text, HTML, or Markdown content.

//Example JSON

{
    "key": "help_webhook",
    "type": "help",
    "help": "<ul><li>Sign in to your account.</li><li>Open form settings, add a <strong>Webhook</strong> action.</li><li>Paste the webhook URL.</li><li>Save and submit to test.</li></ul>"
}
#

Dynamic

Retrieves and displays live, context-aware information during configuration.

// Example JSON

{
  "key": "help_columns",
  "type": "help",
  "label": "Available Columns",
  "source": "const res = await        axios.get(`https://api.example.com/tables/${context.inputData.table}/fields`);\nreturn { message: res.data.fields.map(f => f.name).join(', ') };"
}

Common Properties: key, label, placeholder, visibilityConfiguration and required. Read

source must always resolve to:

return { message: "Dynamic Message" };