Backendless

Learn how to use Backendless with Composio

Overview

SLUG: BACKENDLESS

Description

Backendless is a comprehensive backend-as-a-service (BaaS) platform providing scalable backend functionality for mobile and web applications, including user authentication, data persistence, file storage, and custom API services.

Authentication Details

suffix.one
stringRequired
generic_api_key
stringRequired

Connecting to Backendless

Create an auth config

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

1

Select App

Navigate to Backendless.

2

Configure Auth Config Settings

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

3

Create and Get auth config ID

Click “Create Backendless 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

1from composio import Composio
2
3# Replace these with your actual values
4backendless_auth_config_id = "ac_YOUR_BACKENDLESS_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def 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 Backendless for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, backendless_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

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

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

Tool List

Tool Name: Copy File

Description

Tool to copy a file or directory within Backendless file storage. Use when duplicating files to a new location after verifying source and destination paths.

Action Parameters

source_path
stringRequired
target_path
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Directory

Description

Tool to create a new directory at the specified path. Use when you need to organize files under a new folder structure.

Action Parameters

directory_path
stringRequired
user_token

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Backendless Hive

Description

Tool to create a new Hive. Use when you need to provision a new Hive resource before performing Hive operations. Example: Create a hive named 'groceryStore'.

Action Parameters

hive_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Backendless Timer

Description

Tool to create a new timer with schedule and code. Use when scheduling recurring or one-off tasks to run server-side logic after confirming parameters.

Action Parameters

expire
frequency
objectRequired
name
stringRequired
startDate

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Directory

Description

Tool to delete a directory at the specified path in Backendless file storage. Use when you need to remove folders after confirming the path.

Action Parameters

directory_path
stringRequired
user_token

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete File

Description

Tool to delete a file at the specified path in Backendless file storage. Use after confirming the file's relative path and filename.

Action Parameters

relative_path
stringRequired
user_token

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Backendless Timer

Description

Tool to delete a Backendless timer by name. Use when you need to remove a scheduled timer after confirming its name.

Action Parameters

timer_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Directory Listing

Description

Tool to retrieve a listing of files and directories at a given path. Use when browsing or filtering file storage directories.

Action Parameters

offset
pagesize
path
stringRequired
pattern
sub
user_token

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: General Object Retrieval

Description

Tool to retrieve objects from a specified Backendless table with filtering, sorting, and pagination. Use after confirming the table name and query options. Example: "Get Users where age > 30 sorted by created desc".

Action Parameters

distinct
excludeProps
groupBy
having
loadRelations
offset
pageSize
props
relationsDepth
relationsPageSize
sortBy
table_name
stringRequired
user-token
where

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get All Values

Description

Tool to retrieve all values from a map in a specified Hive. Use when you need to fetch the entire contents of a Hive map at once.

Action Parameters

hive_name
stringRequired
map_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Counter Value

Description

Tool to retrieve the current value of a Backendless counter. Use when you need to inspect an atomic counter's value.

Action Parameters

counter_name
stringRequired
user_token

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get File Count

Description

Tool to get the count of files in a Backendless directory. Use when you need to determine how many items match a filter or include subdirectories.

Action Parameters

count_directories
path
stringRequired
pattern
sub
user_token

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Key Items

Description

Tool to retrieve values for a specified key in a list (all, single, or range). Use when you need specific elements or the entire list from a Hive key. Supports single index retrieval, range retrieval, or full list.

Action Parameters

from_index
hive_name
stringRequired
index
key
stringRequired
to_index

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Backendless Timer

Description

Tool to retrieve information about a specific timer. Use when you need to inspect a timer's schedule and next run details by name.

Action Parameters

name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Map Put

Description

Tool to set or update key-value pairs in a Hive map. Use when you need to add or update multiple entries in a Hive map.

Action Parameters

entries
objectRequired
hive_name
stringRequired
map_name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Move File

Description

Tool to move a file or directory within Backendless file storage. Use when relocating resources to a new path after verifying source and destination.

Action Parameters

source_path
stringRequired
target_path
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Publish Message

Description

Tool to publish a message to a specified messaging channel. Use when you need to send notifications or events to subscribers after confirming channel and payload.

Action Parameters

channel_name
stringRequired
headers
message
Required
publishAt
publisherId
repeatEvery
repeatExpiresAt
user_token

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Reset Counter

Description

Tool to reset a Backendless counter back to zero. Use when you need to reinitialize a counter before starting a new sequence.

Action Parameters

counter_name
stringRequired
user_token

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Set Counter Value

Description

Tool to set a Backendless counter to a specific value conditionally. Use when you need to ensure the counter only updates if it currently matches an expected value.

Action Parameters

counter_name
stringRequired
expected
integerRequired
updatedvalue
integerRequired
user_token

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Backendless Timer

Description

Tool to update schedule or code of an existing timer. Use when you need to modify a timer's configuration after retrieval.

Action Parameters

code
expire
frequency
name
stringRequired
startDate

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Change User Password

Description

Tool to change the password for the current user. Use when you need to securely update a user's password after login. Example prompt: "Change my password to N3wP@ssw0rd!".

Action Parameters

password
stringRequired
user_id
stringRequired
user_token
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete User

Description

Tool to delete a user by user ID. Use when removing a user account after confirming permissions.

Action Parameters

user_id
stringRequired
user_token

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Find User by ID

Description

Tool to retrieve user information by ID. Use when you need to fetch details for a specific user after you have their objectId.

Action Parameters

user_id
stringRequired
user_token

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Grant Permission to User

Description

Tool to grant a permission to a user on a specific data object. Use when precise access rights must be assigned after verifying the table and object IDs. Example: "Grant FIND permission to a user for a Person record".

Action Parameters

object_id
stringRequired
permission
stringRequired
table_name
stringRequired
user
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: User Login

Description

Tool to log in a registered user with identity and password. Use when you need to authenticate a user before making subsequent requests. Example: "Login alice@wonderland.com with password wonderland".

Action Parameters

login
stringRequired
password
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: User Logout

Description

Tool to log out the currently authenticated user. Use when you need to terminate the user session after operations.

Action Parameters

user-token
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: User Password Recovery

Description

Tool to initiate password recovery for a user. Use when a user requests a password reset after forgetting their password. Triggers an email with recovery instructions.

Action Parameters

user_identity
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: User Registration

Description

Tool to register a new user with email and password. Use when creating a user account or converting a guest account to a registered one after collecting credentials. Example: Register 'alice@wonderland.com' with password 'wonderland'.

Action Parameters

email
stringRequired
objectId
password
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Revoke Permission from User

Description

Tool to revoke a permission from a specified user or role on a data table. Use when you need to deny a previously granted data-table operation for a user or role in CloudCode after confirming the target.

Action Parameters

permission
stringRequired
role
table_name
stringRequired
user

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update User

Description

Tool to update properties of an existing Backendless user. Use when you need to modify user profile fields after login. Example: Update phoneNumber to "5551212".

Action Parameters

properties
objectRequired
user_id
stringRequired
user_token

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Validate User Token

Description

Tool to validate a user session token. Use after obtaining a token from login to confirm the session is active.

Action Parameters

userToken
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired