Skip to main content

Installing and Setting up the Stream Deck WhatPulse Plugin

The Stream Deck WhatPulse plugin allows you to display your WhatPulse statistics directly on your Stream Deck device, and gives you the ability to control Profiles to quickly enable time tracking. Additionally, it provides buttons for opening the WhatPulse window and pulsing. In this article, we will guide you through the installation and setup process for the Stream Deck WhatPulse plugin.

You can find a video walkthrough of this article at the bottom of this page.

StreamDeck Plugin

Enabling the Client API in WhatPulse​

Before proceeding with the Stream Deck plugin installation, we need to ensure that the Client API is enabled in the WhatPulse settings. Follow this article for the exact steps.

Downloading the WhatPulse Plugin from the Stream Deck Marketplace​

Once the Client API is enabled, we can proceed with downloading and installing the WhatPulse plugin from the Stream Deck Marketplace. Here's how:

  1. Launch the Stream Deck Marketplace by clicking this link.
  2. If you haven't already, sign into the Marketplace with your Elgato account.
  3. Click the "Get" button on the WhatPulse plugin page to begin the installation process.
  4. Follow any on-screen prompts to complete the installation.

Placing WhatPulse Buttons on the Stream Deck​

Now that the plugin is installed, we can proceed with placing the desired buttons on your Stream Deck device. These buttons will display various statistics from your WhatPulse account. Follow these steps:

  1. Open the Stream Deck application if it's not already open.
  2. Locate the Stream Deck sidebar on the left side of the application window.
  3. Click on the WhatPulse category to reveal the available buttons.
  4. Drag and drop the buttons you want to see onto your Stream Deck device from the sidebar.
  5. Arrange the buttons as desired on your Stream Deck device.
  6. Take note of the two input fields present for each Stream Deck action button:
    • The Header field allows you to add custom text on each button, providing additional context.
    • The Client API field should contain the URL to the WhatPulse Client API, which is typically pre-populated and does not require any changes unless you have modified the Client API's listening ports in WhatPulse settings. This is also a global setting, so you only have to edit it once on a random button, and it'll work for all other buttons as well.
  7. Repeat steps 4-7 for each button you wish to display.

Checking the Connection Status​

To verify if the Stream Deck is successfully connected to WhatPulse via the Client API, the plugin provides an information box on each buttons' configuration page. If connected, you will see Connected to WhatPulse. If not connected, ensure the Client API URL and other settings are correctly configured and try reconnecting.

With the Stream Deck WhatPulse plugin correctly set up, you can now conveniently monitor your WhatPulse statistics, rankings, real-time data, and perform relevant actions with the press of a button on your Stream Deck device. Enjoy the seamless integration between the two!

Controlling Profiles​

Profiles allows you to categorize tracked statistics towards a specific project. With the Stream Deck plugin, you can create dedicated buttons with which you can enable tracking for a specified profile, and the button also lights up when a profile is active.

  1. Open the Stream Deck application if it's not already open.
  2. Locate the Stream Deck sidebar on the left side of the application window.
  3. Click on the WhatPulse category to reveal the available buttons.
  4. Drag and drop the button called Profile toggle from the left side bar to the Stream Deck device canvas.
  5. Click the button you've just added to reveal its settings.
  6. Select the Profile Name from the drop down.
  7. Optionally change the icons of the deactivated and activated state.
    1. By default when a profile isn't active, it'll display a gray WhatPulse logo, and when the profile is active, a green WhatPulse logo. You can change them if you'd like.
note

The available profiles refresh whenever you click on a button. If you've added a new profile in the WhatPulse app while the button settings is open, simply click another button and go back to the Profile toggle button to get the newly added profile.

Video Walkthrough​