Ascora

Learn how to use Ascora with Composio

Overview

SLUG: ASCORA

Description

Ascora is a cloud-based field service management software designed to streamline operations for service-based businesses, offering features such as job scheduling, invoicing, customer management, and mobile access.

Authentication Details

generic_api_key
stringRequired

Connecting to Ascora

Create an auth config

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

1

Select App

Navigate to the Ascora toolkit page and click “Setup Integration”.

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

Tools

Executing tools

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["ASCORA"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Delete Customer

Description

Tool to delete a specific customer by id. use when you need to remove a customer after confirming its existence.

Action Parameters

customer_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Quotation

Description

Tool to create a new quotation. use when submitting a customer quote request via the ascora api.

Action Parameters

addressCountry
string
addressLine1
string
addressLine2
string
addressPostcode
string
addressState
string
addressSuburb
string
companyName
stringRequired
customFields
array
email
Required
enquiryDescription
string
firstName
stringRequired
lastName
stringRequired
mobile
string
phone
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Customer

Description

Tool to delete a specific customer by id. use after confirming the customer exists.

Action Parameters

customer_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Customers

Description

Tool to retrieve a list of customers. use after authenticating with your api key.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Jobs

Description

Tool to retrieve jobs. use when you need to filter and paginate job listings from ascora.

Action Parameters

endDate
string
jobStatus
string
jobType
string
page
integerDefaults to 1
pageSize
integerDefaults to 50
secondaryStatus
string
startDate
string

Action Response

data
objectRequired
error
string
successful
booleanRequired