Gumroad

Learn how to use Gumroad with Composio

Overview

SLUG: GUMROAD

Description

Gumroad simplifies selling digital goods, physical products, and memberships by offering a streamlined checkout, marketing tools, and direct payout options

Authentication Details

client_id
stringRequired
client_secret
stringRequired
full
stringDefaults to https://api.gumroad.comRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to view_sales view_profile
bearer_token
string

Connecting to Gumroad

Create an auth config

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

1

Select App

Navigate to the Gumroad 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 OAuth2

1from composio import Composio
2from composio.types import auth_scheme
3
4# Replace these with your actual values
5gumroad_auth_config_id = "ac_YOUR_GUMROAD_CONFIG_ID" # Auth config ID created above
6user_id = "0000-0000-0000" # UUID from database/application
7
8composio = Composio()
9
10
11def authenticate_toolkit(user_id: str, auth_config_id: str):
12 connection_request = composio.connected_accounts.initiate(
13 user_id=user_id,
14 auth_config_id=auth_config_id,
15 )
16
17 print(
18 f"Visit this URL to authenticate Gumroad: {connection_request.redirect_url}"
19 )
20
21 # This will wait for the auth flow to be completed
22 connection_request.wait_for_connection(timeout=15)
23 return connection_request.id
24
25
26connection_id = authenticate_toolkit(user_id, gumroad_auth_config_id)
27
28# You can also verify the connection status using:
29connected_account = composio.connected_accounts.get(connection_id)
30print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Gumroad 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=["GUMROAD"])
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 Resource Subscriptions

Description

Tool to show all active subscriptions of the user for the input resource. use when you need to review existing webhooks before adding a new one.

Action Parameters

resource_name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Sales

Description

Tool to retrieve all successful sales by the authenticated user. use when you need to list your gumroad sales, optionally filtering by email, date range, product, or pagination.

Action Parameters

after
string
before
string
email
string
page
integer
product_id
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get User

Description

Tool to retrieve the authenticated user's data. use when you need the current user's profile details after authentication.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Subscribe to Resource

Description

Tool to subscribe to a resource. use when you need to receive real-time event webhooks after creating your webhook endpoint.

Action Parameters

post_url
stringRequired
resource_name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Unsubscribe From Resource

Description

Tool to unsubscribe from a resource. use after verifying the subscription id exists to remove webhook.

Action Parameters

resource_subscription_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired