Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

What is a chat tab button?

A chat tab button allows users to initiate your app from the chat tab bar. Here is what a chat tab button looks like on desktop

... and mobile

 

What are the available actions for a Chat tab button?

 

When a user presses the Chat tab button, you can configure it to do one of the below:

  • Launch a modal widget
  • Launch a sidebar widget
  • Launch a browser
  • Send an event to your app servicethe event listener URL

Alongwith launching the above widgets or browser, a client.pressButton event will also be passed as a parameter to the web app URL loaded in any of the above widgets or the browser.

How do I create a chat tab button?

  1. Go through Creating an App to setup your app in the developer dashboard.
  2. In the Advanced Info section, enable the chat tab button.

    Image RemovedImage Added
    Fill in the info below:

    FieldMandatoryDescription
    Tooltip textYesThis will be shown against your app launcher button to the user
    Select action for chat tabYes

    Select an appropriate client action for the attachment picker.

    Type of widget in desktopYesWhether the widget should be modal or sidebar (available only if open widget is selected)
    Action URLYesThe URL that should get called on clicking of the chat tab button (available only if open widget or open browser are selected)
    Send contextYesWhether information related to the event should be sent to the browser (available only if open browser is selected)

    action for the chat tab button.

  3. Go through app installation and install this app into your own Flock account
  4. Whenever a user presses the Chat tab button, the event client.pressButton along with a validation token will be appended to the corresponding client action you selected and sent to your service
  5. Verify the validation token and take the relevant action at your end

...