Gift up

Learn how to use Gift up with Composio

Overview

SLUG: GIFT_UP

Description

Gift Up! is a digital platform that allows businesses to sell, manage, and redeem gift cards online, integrating seamlessly with websites and apps to streamline gift card transactions and promotions.

Authentication Details

generic_api_key
stringRequired

Connecting to Gift up

Create an auth config

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

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 Gift up 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
4gift_up_auth_config_id = "ac_YOUR_GIFT_UP_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 Gift up 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, gift_up_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 [Gift up toolkit’s playground](https://app.composio.dev/app/Gift up)

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=["GIFT_UP"])
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: Get Checkout Settings

Description

Tool to retrieve the current checkout settings. Use when you need to display or audit your checkout configuration.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Company Details

Description

Tool to retrieve company details. Use when you need to fetch the current company associated with the API key.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Gift Cards

Description

Tool to list gift cards. Use when you need to retrieve gift cards with optional filters.

Action Parameters

createdOnOrAfter
string
limit
integer
offset
integer
orderId
string
paymentTransactionId
string
purchaserEmail
string
recipientEmail
string
sku
string
status
string
updatedOnOrAfter
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Item Groups

Description

Tool to list item groups. Use when you need to retrieve all item groups for filtering items by group.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Items

Description

Tool to list items. Use when you need to retrieve all items available for sale, optional filter by groupId.

Action Parameters

groupId
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Locations

Description

Tool to list all locations. Use when you need to retrieve all locations associated with the account.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Report Transactions

Description

Tool to list report transactions with optional filters. Use after setting desired filters to retrieve transactions report.

Action Parameters

code
string
eventOccurredOnOrAfter
string
eventOccurredOnOrBefore
string
events
array
limit
integer
locations
array
offset
integer
test_mode
boolean
users
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List GiftUp Users

Description

Tool to list all users. Use when you need to retrieve all users who have access to your Gift Up! account.

Action Parameters

x_giftup_displayname
string
x_giftup_testmode
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Subscribe to Webhook

Description

Tool to subscribe to a Gift Up! webhook event. Use when you need to register a callback URL for specific account events.

Action Parameters

event
stringRequired
isTestMode
boolean
secret
string
targetUrl
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired