bttn - The simplest internet user interface in the world.
Status: Preview |
Tier: Standard |
Version: 1.0 |
Name |
Summary |
ListBttns ([internal]string fields, [internal]string filter) |
Get list of bttns |
Delete Webhook |
|
ReturnFlowResult (string callbackId, CallbackBody Callback Body) |
Return Flow result |
Get bttn info |
|
Get bttn counter value |
Name |
Summary |
RegisterWebhook (string id, WebhookRequestBody Webhook Request Body) |
When a bttn is pressed |
Name |
Summary |
|
|
|
|
|
|
|
|
|
Summary: Get list of bttns
Description: Gets list of bttns associated with the account.
Syntax:
bttn.ListBttns ([internal]string fields, [internal]string filter)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
fields |
string (fields to include in response items) |
comma separated list of field keys: bid|name_id... |
True |
|
filter |
string (Filter)Values: [all, active] |
all - all bttns, active - only bttns associated with microsoft flow on the bttn portal |
True |
Returns:
Type:array of (BttnListData)
Summary: Bttn device list
Summary: Delete Webhook
Description: Delete a previously assigned bt.tn webhook
Syntax:
bttn.DeleteWebhook (string hookId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
hookId |
string (Id of webhook to delete) |
Id as returned from bt.tn API upon webhook creation |
True |
Returns:
Summary: Return Flow result
Description: Reflect Flow result via bttn device lights.
Syntax:
bttn.ReturnFlowResult (string callbackId, CallbackBody Callback Body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
callbackId |
string (Callback Id) |
CallbackId as received in the bttn trigger. |
True |
|
Callback Body |
|
|
True |
Returns:
Summary: Get bttn info
Description: Gets the bttn device identification information.
Syntax:
bttn.GetBttnInfo (string id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
string (Bttn ID) |
Bttn short ID or device ID. |
True |
Returns:
Type:BttnApiInfo
Summary: Get bttn counter value
Description: Gets the bttn counter value.
Syntax:
bttn.GetBttnCounter (string id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
string (Bttn ID) |
Bttn short ID or device ID. |
True |
Returns:
Type:BttnApiCounter
Summary: When a bttn is pressed
Description: Trigger a flow with a press of a bttn.
Syntax:
bttn.RegisterWebhook (string id, WebhookRequestBody Webhook Request Body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
string (bttn ID) |
bttn short ID or device ID. |
True |
|
Webhook Request Body |
|
|
True |
Returns:
Summary:
Description:
Properties:
Name |
Type |
Summary |
counter |
integer Counter |
Total count of bttn presses (short/long/not pressed) |
bid |
integer Short ID |
Short ID of the bttn (bid) |
address |
string Device ID |
Device ID of the bttn |
name |
string Name |
The name of the bttn as set on the my.bt.tn portal |
emailaddress |
string Email address |
E-mail address associated with the bttn on the my.bt.tn portal |
location |
string Location |
Location of the button as set on the my.bt.tn portal |
url |
string Reference URL |
Reference URL of the bt.tn |
language |
string Language |
Language as set for the bttn on the my.bt.tn portal |
timezone |
string Timezone |
bttn timezone as specified on the my.bt.tn portal |
user |
string User name |
User name associated with the button on the my.bt.tn portal |
Summary:
Description:
Properties:
Name |
Type |
Summary |
bid |
integer Short ID |
Short ID of the bttn (bid) |
address |
string Device ID |
Device ID of the bttn |
name |
string Name |
The name of the bttn as set on the my.bt.tn portal |
emailaddress |
string Email address |
E-mail address associated with the bttn on the my.bt.tn portal |
location |
string Location |
Location of the button as set on the my.bt.tn portal |
url |
string Reference URL |
Reference URL of the bt.tn |
language |
string Language |
Language as set for the bttn on the my.bt.tn portal |
timezone |
string Timezone |
bttn timezone as specified on the my.bt.tn portal |
user |
string User name |
User name associated with the button on the my.bt.tn portal |
Summary:
Description:
Properties:
Name |
Type |
Summary |
bid |
integer Short ID |
Short ID of the bttn (bid) |
name_id |
string Name |
The name of the bttn as set on the my.bt.tn portal |
Summary:
Description:
Properties:
Name |
Type |
Summary |
result |
string Flow Result |
Positive for success, Negative for failure, Wait to extend timeout period Values: [Positive, Negative, Wait] |
Summary:
Description:
Properties:
Name |
Type |
Summary |
url |
string Webhook url |
Url to call in order to trigger webhook |