Beaconstac | Composio Docs

Overview

SLUG: BEACONSTAC

Description

Beaconstac provides a platform for creating and managing QR codes and beacons, enabling businesses to engage customers through proximity marketing and track analytics.

Authentication Details

API Key

generic_api_key

stringRequired

Connecting to Beaconstac

Create an auth config

Use the dashboard to create an auth config for the Beaconstac toolkit. This allows you to connect multiple Beaconstac accounts to Composio for agents to use.

Select App

Navigate to Beaconstac.

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

Create and Get auth config ID

Click “Create Beaconstac Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1 from composio import Composio
2 
3 # Replace these with your actual values
4 beaconstac_auth_config_id = "ac_YOUR_BEACONSTAC_CONFIG_ID" # Auth config ID created above
5 user_id = "0000-0000-0000"  # UUID from database/app
6 
7 composio = Composio()
8 
9 def authenticate_toolkit(user_id: str, auth_config_id: str):
10     # Replace this with a method to retrieve an API key from the user.
11     # Or supply your own.
12     user_api_key = input("[!] Enter API key")
13 
14     connection_request = composio.connected_accounts.initiate(
15         user_id=user_id,
16         auth_config_id=auth_config_id,
17         config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18     )
19 
20     # API Key authentication is immediate - no redirect needed
21     print(f"Successfully connected Beaconstac for user {user_id}")
22     print(f"Connection status: {connection_request.status}")
23     
24     return connection_request.id
25 
26 
27 connection_id = authenticate_toolkit(user_id, beaconstac_auth_config_id)
28 
29 # You can verify the connection using:
30 connected_account = composio.connected_accounts.get(connection_id)
31 print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Beaconstac toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

BEACONSTAC_CREATE_PLACE

Tool Name: Create Place

Description

Tool to create a new place for location-based assets. Use when you need to register a new physical place under an organization.

Action Parameters

address

stringRequired

latitude

stringRequired

longitude

stringRequired

name

stringRequired

organization

integerRequired

Action Response

data

objectRequired

error

successful

booleanRequired

BEACONSTAC_CREATE_QR_TEMPLATE

Tool Name: Create QR Template

Description

Tool to create a new QR Code template. Use when you need reusable design presets for QR codes.

Action Parameters

backgroundColor

backgroundImage

colorDark

colorLight

dataPattern

default

dotScale

eyeBallColor

eyeBallShape

eyeFrameColor

eyeFrameShape

frameColor

frameStyle

frameText

frameTextColor

gradientType

logoImage

logoScale

margin

BEACONSTAC_CREATE_TAG

Tool Name: Create Tag

Description

Tool to create a new tag for organizing QR Codes and other objects. Use when you need to categorize QR Codes under a specific organization.

Action Parameters

name

stringRequired

organization

integerRequired

Action Response

data

objectRequired

error

successful

booleanRequired

BEACONSTAC_CREATE_USER

Tool Name: Create User

Description

Tool to create a new User. Use when onboarding a new user under your organization (Reseller plan and above).

Action Parameters

billing_email

customer_plan

stringRequired

first_name

last_name

organization

integerRequired

password

profile_picture

username

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

BEACONSTAC_DELETE_QR_CODE

Tool Name: Delete QR Code

Description

Tool to delete a QR Code by its ID. Use when you need to remove an existing QR Code after validation.

Action Parameters

integerRequired

Action Response

data

objectRequired

error

successful

booleanRequired

BEACONSTAC_DELETE_QR_TEMPLATE

Tool Name: Delete QR Code Template

Description

Tool to delete a QR Code template by its ID. Use when you need to permanently remove a QR Code template that is no longer needed.

Action Parameters

integerRequired

Action Response

data

objectRequired

error

successful

booleanRequired

BEACONSTAC_DELETE_TAG

Tool Name: Delete Tag

Description

Tool to delete a tag by its ID. Use when you need to remove an existing Tag after validation.

Action Parameters

tag_id

integerRequired

Action Response

data

objectRequired

error

successful

booleanRequired

BEACONSTAC_LIST_BULK_QR_CODES

Tool Name: List Bulk QR Code Collections

Description

Tool to list Bulk QR Code collections. Use when you need to filter, search, or order your bulk QR Code collections.

Action Parameters

name__icontains

ordering

page

integerDefaults to 1

page_size

integerDefaults to 10

qr_data_type

Action Response

data

objectRequired

error

successful

booleanRequired

BEACONSTAC_LIST_ORGANIZATIONS

Tool Name: List Organizations

Description

Tool to list organizations. Use when you need to fetch all organizations accessible to the authenticated account.

Action Parameters

Action Response

data

arrayRequired

error

successful

booleanRequired

BEACONSTAC_LIST_PLACES

Tool Name: List Places

Description

Tool to list your Places. Use when you need to browse or search your account's Places with filtering and ordering.

Action Parameters

name

name__icontains

ordering

page

integerDefaults to 1

page_size

integerDefaults to 10

Action Response

data

objectRequired

error

successful

booleanRequired

BEACONSTAC_LIST_QR_TEMPLATES

Tool Name: List QR Templates

Description

Tool to list all QR code templates in your account. Use when you need to filter and paginate templates.

Action Parameters

name__icontains

organization

integerRequired

page

page_size

Action Response

data

objectRequired

error

successful

booleanRequired

BEACONSTAC_LIST_TAGS

Tool Name: List Tags

Description

Tool to list all tags with optional filtering and pagination. Use when you need to browse or search tags in your account.

Action Parameters

name__icontains

ordering

page

integerDefaults to 1

page_size

integerDefaults to 10

Action Response

data

objectRequired

error

successful

booleanRequired

BEACONSTAC_LIST_USERS

Tool Name: List Users

Description

Tool to list all users with optional filtering, searching, ordering, and pagination. Use when you need to retrieve user records across your organization.

Action Parameters

customer_plan

date_joined__gt

date_joined__gte

date_joined__lt

date_joined__lte

email__exact

email__icontains

first_name__exact

first_name__icontains

last_name__exact

last_name__icontains

ordering

organization

page

integerDefaults to 1

page_size

integerDefaults to 10

subscription_state

username__exact

username__icontains

Action Response

data

objectRequired

error

successful

booleanRequired

BEACONSTAC_PERIOD_OVERVIEW

Tool Name: Get Period Overview

Description

Tool to get period overview analytics for products including counts, impressions, and conversion percentage. Use after specifying the product_type and time interval.

Action Parameters

from_timestamp

integerRequired

organization

integerRequired

product_type

stringRequired

to_timestamp

integerRequired

Action Response

data

objectRequired

error

successful

booleanRequired

BEACONSTAC_PRODUCT_OVERVIEW

Tool Name: Get Product Overview

Description

Tool to get analytics overview for a specified product type over a given time interval. Use after specifying the product type and time range to obtain summary metrics.

Action Parameters

from_timestamp

integerRequired

organization

integerRequired

product_type

stringRequired

to_timestamp

integerRequired

Action Response

data

objectRequired

error

successful

booleanRequired

BEACONSTAC_RETRIEVE_QR_CODE

Tool Name: Retrieve QR Code

Description

Tool to retrieve details of a specific QR Code by its ID. Use when you need to fetch or verify QR Code properties after creation or update.

Action Parameters

integerRequired

Action Response

data

objectRequired

error

successful

booleanRequired

BEACONSTAC_RETRIEVE_USER

Tool Name: Retrieve User

Description

Tool to retrieve the details of an existing User by ID. Use when you need to fetch a user's profile after confirming its existence.

Action Parameters

integerRequired

Action Response

data

objectRequired

error

successful

booleanRequired

BEACONSTAC_UPDATE_PLACE

Tool Name: Update Place

Description

Tool to update the specified Place by ID. Use after retrieving the Place to modify its details, such as name, address, or coordinates.

Action Parameters

address

business_color

business_cover_url

business_icon_url

latitude

longitude

name

stringRequired

organization

integerRequired

place_id

integerRequired

Action Response

data

objectRequired

error

successful

booleanRequired

BEACONSTAC_UPDATE_QR_CODE

Tool Name: Update QR Code

Description

Tool to update an existing QR Code by its ID. Use when you need to modify QR Code attributes; only provided fields are changed.

Action Parameters

attributes

campaign

fields_data

BEACONSTAC_UPDATE_TAG

Tool Name: Update Tag

Description

Tool to update an existing tag by its ID. Use when you need to modify a tag's name or color after confirming its ID via list_tags.

Action Parameters

color

name

tag_id

integerRequired

Action Response

data

objectRequired

error

successful

booleanRequired

BEACONSTAC_UPDATE_USER

Tool Name: Update User

Description

Tool to update an existing User. Use when you need to modify profile details or organization of a User by their ID.

Action Parameters

first_name

last_name

organization

profile_picture

user_id

integerRequired

Action Response

data

objectRequired

error

successful

booleanRequired