Dashmaster 2K

The Dashmaster 2K integration lets Action Phrase control dashboards and display devices through the Dashmaster 2K Public API.

Use spoken phrases, manual controls, scripts, and other Action Phrase triggers to:

  • Change the dashboard shown on a device.
  • Clear a device’s assigned dashboard.
  • Rotate a dashboard display.
  • Identify a physical display.
  • Request information about dashboards and devices.
  • Call additional API endpoints with raw requests.

Dashmaster 2K devices display dashboards through unique browser URLs. Changing a device’s assigned dashboard updates the content shown on that display. Learn more in the Dashmaster 2K device documentation.

Requirements

You need:

  • Action Phrase Core or higher.
  • A Dashmaster 2K account.
  • A Dashmaster 2K API token.
  • An internet connection.
  • At least one Dashmaster 2K dashboard or device for device-control commands.

The integration communicates with the Dashmaster 2K cloud API over HTTPS. Action Phrase does not need to be on the same local network as the display device.

Create an API token

  1. Sign in to your Dashmaster 2K account.
  2. Open the Dashmaster 2K API page.
  3. Generate a new API token.
  4. Copy the token. Dashmaster 2K tokens begin with dm_.
  5. Store the token securely.

Action Phrase sends the token as a Bearer token with every request:

Authorization: Bearer dm_xxx

Paste the token into Action Phrase without adding Bearer. If the value already begins with Bearer, Action Phrase will not add it a second time.

Treat your API token like a password. Anyone with the token may be able to view or change the Dashmaster 2K resources accessible to your account. Revoke and replace the token immediately if it is exposed.

Configure the action

  1. In Action Phrase, open Actions.
  2. Create a new action or edit an existing action.
  3. Select Dashmaster 2K as the action type.
  4. Leave Base URL set to:
https://app.dashmaster2k.com/api-v1
  1. Paste your token into API Token.
  2. Leave Use Raw Request off.
  3. Select a command.
  4. Configure the command’s device, dashboard, or rotation parameters.
  5. Test the action.
  6. Add the action to a phrase, script, or other automation.

Testing Update Device or Identify Device sends the real command to Dashmaster 2K. Use a non-critical display when testing a new configuration.

Connection settings

Setting Description
Base URL The Dashmaster 2K API endpoint. Keep the default value unless Dashmaster 2K provides a different endpoint.
API Token The token generated in your Dashmaster 2K account. Action Phrase sends it in the Authorization header.

Available commands

Command Purpose Required parameters
List Dashboards Request all dashboards owned by the authenticated Dashmaster 2K user. None
List Devices Request all devices owned by the authenticated Dashmaster 2K user. None
Get Device Request the current information for one device. Device ID
Update Device Change a device’s dashboard, rotation, or both. Device ID and at least one update
Identify Device Display an identification overlay on a device. Device ID

List Dashboards, List Devices, and Get Device send read-only API requests, but Action Phrase does not currently expose the returned JSON as a phrase variable or action output.

Find device and dashboard IDs

Dashmaster 2K commands use API IDs rather than display names.

You can retrieve IDs through the interactive Dashmaster 2K API documentation:

  • GET /dashboards returns dashboard IDs.
  • GET /devices returns device IDs and their assigned dashboard IDs.
  • GET /devices/{id} returns the current state of one device.

Use the exact ID returned by the API.

Example device ID:

DEVICE123

Example dashboard ID:

DASH789

Refer to the Dashmaster 2K Public API documentation for the complete response formats.

Update Device

Use Update Device to change the dashboard shown on a device, rotate its display, or perform both changes in one request.

Parameters

Parameter Description
Device ID The ID of the device to update.
Dashboard Choose whether to leave the dashboard unchanged, assign a dashboard, or clear the current dashboard.
Dashboard ID The dashboard to assign. Appears when Set Dashboard is selected.
Rotation Choose whether to leave the rotation unchanged or set a new rotation.
Degrees The clockwise display rotation: 0, 90, 180, or 270.

Dashboard options

Option Result
Leave Unchanged The device keeps its current dashboard.
Set Dashboard The device displays the dashboard specified by Dashboard ID.
Clear Dashboard Removes the currently assigned dashboard from the device.

Rotation options

Option Result
Leave Unchanged The device keeps its current rotation.
Set Rotation Applies the selected clockwise rotation.

Update Device must change at least one value. If both Dashboard and Rotation are set to Leave Unchanged, Action Phrase does not send a request.

Example: switch a lobby display

Parameter Value
Device ID DEVICE123
Dashboard Set Dashboard
Dashboard ID DASH789
Rotation Leave Unchanged

This changes the dashboard shown on the device without changing its rotation.

Example: rotate a display

Parameter Value
Device ID DEVICE123
Dashboard Leave Unchanged
Rotation Set Rotation
Degrees 90

This rotates the existing dashboard clockwise by 90 degrees.

Example: update both settings

Parameter Value
Device ID DEVICE123
Dashboard Set Dashboard
Dashboard ID DASH789
Rotation Set Rotation
Degrees 270

Action Phrase sends both changes in one request.

Identify Device

The Identify Device command briefly displays the device ID overlay on the selected screen. Dashmaster 2K shows the overlay for approximately three seconds.

Use this command when you need to determine which physical screen corresponds to a device record.

Parameter Value
Device ID The device to identify

Use phrase variables

The Device ID and Dashboard ID fields support Action Phrase template variables.

For example, a phrase could use:

Show {{dashboardId}} on the lobby display

Configure the action with:

Parameter Value
Device ID DEVICE123
Dashboard Set Dashboard
Dashboard ID ``

The supplied value must resolve to a valid Dashmaster 2K dashboard ID. The integration does not automatically convert a dashboard name into its ID.

For frequently used dashboards, creating separate actions with fixed dashboard IDs is usually simpler and less error-prone.

Raw requests

Turn on Use Raw Request to access a Dashmaster 2K endpoint that is not included in the command picker.

Raw request settings

Setting Description
Raw Method GET, POST, PUT, PATCH, or DELETE.
Raw Path A path relative to the configured Base URL. Query parameters are supported.
Raw JSON Body An optional JSON request body for POST, PUT, and PATCH.

Example:

Method: PATCH
Path: /devices/DEVICE123
Body: {"dashboardId":"DASH789","rotation":90}

A path that already begins with /api-v1 will not duplicate the API prefix.

/api-v1/devices/DEVICE123/identify

Raw paths and JSON bodies can contain Action Phrase template variables.

Raw JSON bodies are not sent with GET or DELETE requests.

Use relative paths whenever possible. If you enter an absolute URL, Action Phrase sends your Dashmaster 2K Bearer token to that URL. Never use an absolute URL unless you trust and have verified its destination.

Troubleshooting

Nothing happens when the action runs

Confirm that:

  • An API token has been entered.
  • The Base URL is valid.
  • A command has been selected.
  • Every required Device ID or Dashboard ID is present.
  • Update Device changes at least one setting.
  • The device has internet access and is displaying its Dashmaster 2K device URL.

Unauthorized request

An invalid or missing token produces an HTTP 401 response.

Generate a new token from the Dashmaster 2K API page, update the action, and test it again.

Device or dashboard not found

An invalid ID produces an HTTP 404 response. Confirm that:

  • You entered the API ID rather than the display name.
  • The device or dashboard still exists.
  • The resource belongs to the account that generated the token.

Invalid update

Dashmaster 2K may return HTTP 400 when an update is missing required information or contains an invalid value.

Check that:

  • Set Dashboard includes a valid Dashboard ID.
  • Rotation is 0, 90, 180, or 270.
  • At least one device property is being changed.

A read command does not show any data

List Dashboards, List Devices, and Get Device do not currently place the API response into an Action Phrase variable. Use the interactive API documentation when you need to inspect the returned dashboard or device records.

results matching ""

    No results matching ""