SunshineConversationsClient::PrechatCapture
August 27, 2025 ยท View on GitHub
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| avatar_url | String | Sets the URL of the avatar to use for the automatic reply to the prechat capture messages. | [optional][default to 'undefined'] |
| enabled | Boolean | If true, enables the Prechat Capture add-on when the Web Messenger is initialized. | [optional][default to false] |
| enable_email_linking | Boolean | f true and Mailgun is integrated, will automatically link submitted emails. | [optional][default to false] |
| fields | Array<Field> | Array of Fields. Overrides the default Prechat Capture fields to define a custom form. | [optional] |
Example
require 'sunshine-conversations-client'
instance = SunshineConversationsClient::PrechatCapture.new(
avatar_url: https://domain.com/images/avatar.png,
enabled: null,
enable_email_linking: null,
fields: [{"type":"email","name":"email","label":"Email","placeholder":"your@email.com"},{"type":"text","name":"company-website","label":"Company website","placeholder":"mycompany.com"}]
)