BellButton

API to manage bell button services.

List bell buttons.

get

List all available bell button resources.

Authorizations

HueApplicationKey

hue-application-keystringRequired

Responses

200

BellButton Success Response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

application/json

406

Not Acceptable

application/json

409

Conflict

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

507

Insufficient Storage

application/json

get

/clip/v2/resource/bell_button

HTTPcURLJavaScriptPython

GET /clip/v2/resource/bell_button HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "type": "light",
      "id": "3883f8bf-30a3-445b-ac06-b047d50599df",
      "id_v1": "/lights/8",
      "owner": {
        "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
        "rtype": "device"
      },
      "metadata": {
        "control_id": 1
      },
      "bell": {
        "bell_report": {
          "updated": "2026-03-31T11:36:55.188Z",
          "event": "ring"
        },
        "last_event": "ring"
      }
    }
  ]
}

Get bell button.

get

Get details of a single bell button resource from its given {bellButtonId}.

Authorizations

HueApplicationKey

hue-application-keystringRequired

Path parameters

bellButtonIdstringRequired

ID of the bell button

Responses

200

BellButton Success Response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

application/json

406

Not Acceptable

application/json

409

Conflict

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

507

Insufficient Storage

application/json

get

/clip/v2/resource/bell_button/{bellButtonId}

HTTPcURLJavaScriptPython

GET /clip/v2/resource/bell_button/{bellButtonId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Accept: */*

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "type": "light",
      "id": "3883f8bf-30a3-445b-ac06-b047d50599df",
      "id_v1": "/lights/8",
      "owner": {
        "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
        "rtype": "device"
      },
      "metadata": {
        "control_id": 1
      },
      "bell": {
        "bell_report": {
          "updated": "2026-03-31T11:36:55.188Z",
          "event": "ring"
        },
        "last_event": "ring"
      }
    }
  ]
}

Update bell button.

put

Update a single bell button resource from its given {bellButtonId}.

Authorizations

HueApplicationKey

hue-application-keystringRequired

Path parameters

bellButtonIdstringRequired

ID of the bell button

Body

application/json

typestringOptional

Type of the supported resources (always bell_button here)

Responses

200

Success

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

405

Method Not Allowed

application/json

406

Not Acceptable

application/json

409

Conflict

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

503

Service Unavailable

application/json

507

Insufficient Storage

application/json

put

/clip/v2/resource/bell_button/{bellButtonId}

HTTPcURLJavaScriptPython

PUT /clip/v2/resource/bell_button/{bellButtonId} HTTP/1.1
Host: 192.168.1.0
hue-application-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "type": "text"
}

{
  "errors": [
    {
      "description": "text"
    }
  ],
  "data": [
    {
      "rid": "42edd1f5-9538-4180-9ced-2d9e07f26d0f",
      "rtype": "device"
    }
  ]
}