Send Message with Botstar API on New Light State from Philips Hue API

Pipedream makes it easy to connect APIs for Botstar, Philips Hue and 3,000+ other apps remarkably fast.

Trigger workflow on

New Light State from the Philips Hue API

Next, do this

Send Message with the Botstar API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Philips Hue trigger and Botstar action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Light State trigger
1. Connect your Philips Hue account
2. Configure timer
3. Configure Username
4. Optional- Select a Light ID
5. Optional- Select a Group ID
Configure the Send Message action
1. Connect your Botstar account
2. Configure Recipient ID
3. Configure Message
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Light State on Philips Hue

Description:Emit new event when the state of a light changes (e.g., turned on/off, brightness adjusted, color changed). [See the documentation](https://developers.meethue.com/develop/hue-api-v2/api-reference/#resource_light__id__put)

Version:0.0.1

Key:philips_hue-new-light-state

View on GitHub

Philips Hue Overview#

The Philips Hue API offers rich control over Philips Hue smart lighting systems. Via Pipedream, you can automate your lighting based on various triggers – think syncing lights with the sun's cycle, changing color to indicate new emails, or even integrating with motion sensors for a smart-home experience. With Pipedream's capabilities to connect to countless services, the possibilities of creating personalized lighting scenarios are vast, limited only by your imagination and the availability of triggers or events from other services and devices.

Trigger Code#

import common from "../common/base.mjs"; import { ConfigurationError } from "@pipedream/platform"; import sampleEmit from "./test-event.mjs"; export default { ...common, key: "philips_hue-new-light-state", name: "New Light State", description: "Emit new event when the state of a light changes (e.g., turned on/off, brightness adjusted, color changed). [See the documentation](https://developers.meethue.com/develop/hue-api-v2/api-reference/#resource_light__id__put)", version: "0.0.1", type: "source", dedupe: "unique", props: { ...common.props, lightId: { propDefinition: [ common.props.philipsHue, "lightId", (c) => ({ username: c.username, }), ], optional: true, }, groupId: { propDefinition: [ common.props.philipsHue, "groupId", (c) => ({ username: c.username, }), ], optional: true, }, }, hooks: { deploy() { if ((!this.lightId && !this.groupId) || (this.lightId && this.groupId)) { throw new ConfigurationError("Must specify exactly one of Light ID or Group ID"); } }, }, methods: { ...common.methods, getSummary(item) { return `${this.lightId ? "Light" : "Group"} with ID ${item.id} changed ${item.propertyChanged} state`; }, }, async run() { const previousData = this._getPreviousData(); const args = { username: this.username, }; const { data } = this.lightId ? await this.philipsHue.getLight({ ...args, lightId: this.lightId, }) : await this.philipsHue.getGroup({ ...args, groupId: this.groupId, }); for (const item of data) { const itemData = { on: item?.on, brightness: item?.dimming?.brightness, color: item?.color?.xy, }; if ( previousData[item.id] && JSON.stringify(previousData[item.id]) === JSON.stringify(itemData) ) { continue; } item.propertyChanged = !previousData[item.id] || previousData[item.id].on !== itemData.on ? "on/off" : previousData[item.id].brightness !== itemData.brightness ? "brightness" : "color"; this.emitEvent(item); previousData[item.id] = itemData; } this._setPreviousData(previousData); }, sampleEmit, };

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Philips Hue	`philipsHue`	`app`	This component uses the Philips Hue app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Username	`username`	`string`	The username to use. See the documentation for information on how to create an authorized username
Light ID	`lightId`	`string`	Select a value from the drop down menu.
Group ID	`groupId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

Philips Hue uses OAuth authentication. When you connect your Philips Hue account, Pipedream will open a popup window where you can sign into Philips Hue and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Philips Hue API.

Pipedream requests the following authorization scopes when you connect your account:

About Philips Hue#

Smart light lets you do more. Whether that’s creating the perfect atmosphere for a relaxing night in or bringing the thrill of the theater into your living room, Philips Hue helps you think larger than light.

Action#

Send Message on Botstar

Description:Send a message to a user via BotStar. [See the docs](https://apis.botstar.com/docs/#/Messages/post_messages)

Version:0.0.2

Key:botstar-send-message

View on GitHub

Botstar Overview#

Botstar API lets you extend the capabilities of Botstar's chatbot platform. It empowers you to programmatically manage and interact with your chatbots, access chat and user data, and integrate with external services. With Pipedream, you can leverage these API functions to automate workflows between Botstar and other apps, trigger actions based on chat events, or synchronize chatbot data with CRM platforms, databases, or marketing tools.

Action Code#

import botstar from "../../botstar.app.mjs"; export default { key: "botstar-send-message", name: "Send Message", description: "Send a message to a user via BotStar. [See the docs](https://apis.botstar.com/docs/#/Messages/post_messages)", version: "0.0.2", annotations: { destructiveHint: false, openWorldHint: true, readOnlyHint: false, }, type: "action", props: { botstar, recipientId: { type: "string", label: "Recipient ID", description: "The user ID to send the message to. To find a user ID, login to app.botstar.com > Report & Insight > Audience > click on a chat user The User ID is displayed under the information on the left of the screen", }, message: { type: "string", label: "Message", description: "The text message to send", }, }, async run({ $ }) { const response = await this.botstar.sendMessage({ $, data: { recipient: { id: this.recipientId, }, message: { text: this.message, }, }, }); $.export("$summary", `Sent message to user ${this.recipientId}`); return response; }, };

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Botstar	`botstar`	`app`	This component uses the Botstar app.
Recipient ID	`recipientId`	`string`	The user ID to send the message to. To find a user ID, login to app.botstar.com > Report & Insight > Audience > click on a chat user The User ID is displayed under the information on the left of the screen
Message	`message`	`string`	The text message to send

Action Authentication#

Botstar uses API keys for authentication. When you connect your Botstar account, Pipedream securely stores the keys so you can easily authenticate to Botstar APIs in both code and no-code steps.