Gatherup

Learn how to use Gatherup with Composio

Overview

SLUG: GATHERUP

Description

GatherUp is a customer feedback and online review management platform that helps businesses collect, manage, and leverage customer feedback to improve their online reputation.

Authentication Details

generic_api_key
stringRequired
generic_secret
stringRequired

Connecting to Gatherup

Create an auth config

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

1

Select App

Navigate to Gatherup.

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 Gatherup 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
4gatherup_auth_config_id = "ac_YOUR_GATHERUP_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 Gatherup 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, gatherup_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 Gatherup 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=["GATHERUP"])
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 GatherUp Business

Description

Tool to delete an existing business location. Use when you need to remove a business after validating its ID and signature.

Action Parameters

businessId
integerRequired
clientId
stringRequired
hash
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Generate GatherUp Hash Signature

Description

Tool to generate a SHA-256 hash signature required by GatherUp endpoints. Signature rule (commonly documented by GatherUp): SHA-256 over: privateKey + concatenation of all request parameter key-value pairs (excluding 'hash'), ordered alphabetically by key. Include clientId when present.

Action Parameters

clientId
string
parameters
object
privateKey
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get GatherUp Business

Description

Tool to get business details by business ID. Use when you have clientId and valid hash to retrieve a business location record.

Action Parameters

businessId
integerRequired
clientId
stringRequired
hash
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get GatherUp Business Types

Description

Tool to get business types. Use to fetch available business type identifiers after generating a valid hash signature; optionally filter by search term.

Action Parameters

clientId
stringRequired
hash
stringRequired
search
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get GatherUp Customer

Description

Tool to get customer details by ID. Endpoint: POST /customer/get

Action Parameters

clientId
stringRequired
customerId
integerRequired
hash
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Search GatherUp Business

Description

Tool to find business ID by customField or extraField. Endpoint: POST /business/search

Action Parameters

by
stringRequired
clientId
stringRequired
hash
stringRequired
search
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Send GatherUp Customer Feedback

Description

Tool to send a feedback request to a customer. Use when prompting customers for feedback after an interaction. Ensure a valid hash signature is provided.

Action Parameters

checkThreshold
integer
clientId
stringRequired
customerId
integerRequired
hash
stringRequired
jobId
string
ratingRevision
integerDefaults to 1

Action Response

data
objectRequired
error
string
successful
booleanRequired