Jobnimbus

Learn how to use Jobnimbus with Composio

Overview

SLUG: JOBNIMBUS

Description

JobNimbus is a CRM and project management software designed for contractors, helping streamline scheduling, estimates, invoicing, and job tracking.

Authentication Details

generic_api_key
stringRequired

Connecting to Jobnimbus

Create an auth config

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

1

Select App

Navigate to Jobnimbus.

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 Jobnimbus 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
4jobnimbus_auth_config_id = "ac_YOUR_JOBNIMBUS_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": user_api_key}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Jobnimbus 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, jobnimbus_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 Jobnimbus toolkit’s playground

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=["JOBNIMBUS"])
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: Create Location

Description

Tool to create a new location in jobnimbus. use after gathering address and contact details.

Action Parameters

address_line1
string
address_line2
string
city
string
code
string
country_name
string
is_active
booleanDefaults to True
name
stringRequired
phone
string
state_text
string
zip
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Activity by ID

Description

Tool to retrieve a specific activity by its id. use after confirming the activity's jnid is valid.

Action Parameters

jnid
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Contact by ID

Description

Tool to retrieve a contact by id. use after obtaining the contact’s jnid to fetch full details.

Action Parameters

jnid
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Contacts

Description

Tool to list all contacts. use when you need to fetch multiple contacts, e.g., for reporting or synchronization.

Action Parameters

fields
string
filter
string
from
integer
size
integerDefaults to 1000
sort_direction
stringDefaults to desc
sort_field
stringDefaults to date_created

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create File Attachment Type

Description

Tool to create a new file attachment type. use when you need to register a custom document category before uploading files.

Action Parameters

IsActive
boolean
TypeName
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Material Order

Description

Tool to create a new material order (v2). use when you need to place a materials order for a contact after gathering item details.

Action Parameters

assignedToId
integer
contactId
integerRequired
expectedDate
string
materialOrderItems
array
notes
string
number
string
status
string
vendorId
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Task

Description

Tool to create a new task. use when scheduling or tracking tasks linked to contacts or jobs.

Action Parameters

date_end
integer
date_start
integerRequired
record_type
integer
record_type_name
stringRequired
related
array
title
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Workflow Status

Description

Tool to create a new status in an existing workflow. use after confirming the workflow id to add specialized status entries like 'lead' or 'inspection'.

Action Parameters

force_mobile_sync
boolean
is_active
booleanDefaults to True
is_archived
boolean
is_closed
boolean
is_lead
boolean
name
stringRequired
send_to_quickbooks
boolean
workflowid
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get File Attachment by ID

Description

Tool to retrieve a specific file attachment's raw content by id.

Action Parameters

jnid
stringRequired

Action Response

data
stringRequired
error
string
successful
booleanRequired

Tool Name: Get Account Settings

Description

Tool to retrieve account-wide settings (workflows, types, sources). use after authenticating to load or refresh workflow and source mappings.

Action Parameters

actor
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Contact

Description

Tool to update an existing contact. use when you have a contact's jnid and need to modify its fields. call after fetching or creating a contact.

Action Parameters

addressLine1
string
addressLine2
string
city
string
company
string
contactType
string
description
string
displayName
string
email
string
externalId
string
faxNumber
string
firstName
string
homePhone
string
jnid
stringRequired
lastName
string
mobilePhone
string
salesRepName
string
sourceName
string
stateText
string
statusName
string
tags
array
website
string
workPhone
string
zip
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Tasks

Description

Tool to list all tasks. use when you need an overview of tasks for planning or review.

Action Parameters

assigned_to
integer
due_date
string
page
integer
per_page
integer
status
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Activities

Description

Tool to retrieve all activities. use after authentication to fetch a paginated list of activities.

Action Parameters

fields
string
filter
string
offset
integer
size
integerDefaults to 1000
sort_direction
stringDefaults to desc
sort_field
stringDefaults to date_created

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Invoices

Description

Tool to list all invoices (v2). use when you need to fetch multiple invoice records.

Action Parameters

fields
string
filter
string
from
integer
size
integerDefaults to 1000
sort_direction
stringDefaults to desc
sort_field
stringDefaults to date_created

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Material Orders

Description

Tool to list all material orders (v2). use after authentication to fetch multiple material order records.

Action Parameters

fields
string
filter
string
from
integer
size
integerDefaults to 1000
sort_direction
stringDefaults to desc
sort_field
stringDefaults to date_created

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Payments

Description

Tool to retrieve payments list with optional filters. use after auth.

Action Parameters

contactId
integer
dateFrom
string
dateTo
string
jobId
integer
page
integerDefaults to 1
perPage
integerDefaults to 100

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Products

Description

Tool to list all products. use after authentication to fetch full product catalog.

Action Parameters

fields
string
filter
string
from
integer
size
integerDefaults to 1000
sort_direction
stringDefaults to desc
sort_field
stringDefaults to date_created

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Work Orders

Description

Tool to retrieve all work orders (v2). use after authentication when you need a paginated list of work orders.

Action Parameters

fields
string
filter
string
from
integer
size
integerDefaults to 1000
sort_direction
stringDefaults to desc
sort_field
stringDefaults to date_created

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Product by ID

Description

Tool to retrieve a specific product by id (v2). use after confirming the product's jnid to fetch its details.

Action Parameters

jnid
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Task

Description

Tool to update an existing task. use after confirming the task’s jnid and desired changes.

Action Parameters

date_end
integer
date_start
integer
description
string
is_completed
boolean
jnid
stringRequired
priority
integer
record_type
integer
record_type_name
string
related
array
title
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Units of Measure

Description

Tool to retrieve list of supported units of measure. use after authenticating when you need to present or validate measurement units.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired