Webhook API – basics and guidelines
2 min read
- View as Markdown Open this page as plain Markdown (opens in a new tab)
- Open in ChatGPT Ask questions about this page (opens in a new tab)
- Open in Claude Ask questions about this page (opens in a new tab)
- Open in Google AI Studio Ask questions about this page (Google account required) (opens in a new tab)
Webhook API Basics #
Compatible with Luxafor 2.0 software (Luxafor Flag, Luxafor Colorblind Flag, Luxafor Orb, Luxafor Bluetooth Pro, Luxafor Bluetooth)
Webhook API allows controlling your Luxafor device by sending HTTP POST requests to API endpoints, allowing you to integrate Luxafor with your applications and services.
- All API method endpoints are HTTPS URLs.
- The parameters to methods are passed as JSON in the HTTP POST body.
- HTTP request header “Content-Type: application/JSON” is required.
- The response body is JSON. It is possible to receive server error as an HTTP status code other than 200 in response.
- “userId” is your Luxafor ID and can be found on the “Webhook” tab in Luxafor software.
- To turn the Luxafor device off, use “Solid custom color” and send the following code: 000000
Available Methods #
Solid base color #
API endpoint: https://api.luxafor.com/webhook/v1/actions/solid_color
Request parameters:
{
"userId": "<your Luxafor ID>",
"actionFields":{
"color": "<color from list below>"
}
}
Accepted colors: “red”, “green”, “yellow”, “blue”, “white”, “cyan”, “magenta”
Solid custom color #
API endpoint: https://api.luxafor.com/webhook/v1/actions/solid_color
Request parameters:
{
"userId": "<your Luxafor ID>",
"actionFields":{
"color": "custom",
"custom_color": "<6 symbol hex color code>"
}
}
Blink #
API endpoint: https://api.luxafor.com/webhook/v1/actions/blink
Request parameters:
{
"userId": "<your Luxafor ID>",
"actionFields":{
"color": "<color from list below>"
}
}
Accepted colors: “red”, “green”, “yellow”, “blue”, “white”, “cyan”, “magenta”.
Pattern #
API endpoint: https://api.luxafor.com/webhook/v1/actions/pattern
Request parameters:
{
"userId": "<your Luxafor ID>",
"actionFields":{
"pattern": "pattern from list below"
}
}
Accepted patterns: “police”, “traffic lights”, “random 1”, “random 2”, “random 3”, “random 4”, “random 5”. Additional patterns accepted on Windows only: “rainbow”, “sea”, “white wave”, “synthetic”.
Basic Troubleshooting
- Make sure, that the correct form of the quotation marks is being used in the body (“ instead of ”)
- Check that your Luxafor ID, as well as color name and code, are put in quotation marks.
- Although it does not apply to all environments it is possible that your input body is case-sensitive, therefore, we would suggest for you to use lowercase letters when entering the 6-symbol hexadecimal color code.