ring tools · Foyer Connect

`ring.connection.delete`

writesconfirm

Delete a Ring connection by id. Tenant-scoped. Cascade-deletes its doorbells.

Input parameters

Field	Type	Required	Notes
`id`	string	yes

Output fields

Field	Type	Required	Notes
`ok`	literal	yes	One of: true

`ring.connection.upsert`

writesconfirm

Create or update a Ring account connection. `ringType` is 'mock' (placeholder) or 'ring' (real cloud). `credentials.refreshToken` is stored encrypted. Pass `id` to update, omit to insert.

Input parameters

Field	Type	Required	Notes
`id`	string	no
`label`	string	yes
`ringType`	enum	no	One of: ring, mock — Default: "mock"
`credentials`	object	no	Default: {}
`credentials.refreshToken`	string	no
`active`	boolean	no	Default: true

Output fields

Field	Type	Required	Notes
`id`	string	yes

`ring.doorbell.delete`

writesconfirm

Delete a Ring doorbell by id. Tenant-scoped.

Input parameters

Field	Type	Required	Notes
`id`	string	yes

Output fields

Field	Type	Required	Notes
`ok`	literal	yes	One of: true

`ring.doorbell.upsert`

writesconfirm

Create or update a Ring doorbell behind a connection. `deviceId` is the Ring camera id. Pass `id` to update, omit to insert.

Input parameters

Field	Type	Required	Notes
`id`	string	no
`connectionId`	string	yes
`deviceId`	string	yes
`name`	string	yes
`location`	string	no
`sortOrder`	integer	no	Default: 0
`active`	boolean	no	Default: true

Output fields

Field	Type	Required	Notes
`id`	string	yes

`ring.list`

read-only

List Ring doorbells for this tenant (id, name, location, active). Credentials and device ids are NOT returned — view/edit via the operator settings UI.

Input parameters

Returns object.

Output fields

Field	Type	Required
`doorbells`	array of object	yes
`doorbells.id`	string	yes
`doorbells.name`	string	yes
`doorbells.location`	string · nullable	yes
`doorbells.active`	boolean	yes
`doorbells.connectionId`	string	yes