Gumroad
With Gumroad modules in Boost.space Integrator, you can watch for new sales and subscriptions, list and retrieve products and sales, and make API calls.
To get started with Gumroad, create an account at gumroad.com.
The module dialog fields that are displayed in bold (in the Boost.space Integrator scenario, not in this documentation article) are mandatory.
Connecting Gumroad to Boost.space Integrator
-
Go to your Boost.space Integrator scenario and select the Gumroad module you want to use.
-
Under Connection, click Add.
-
Give your new connection a name.
-
Click Save.
-
A prompt from gumroad.com appears. Log in to your Gumroad account.
-
Click Authorize.
You have successfully established the connection.
Products
List Products
Returns a list of products.
Connection
Establish a connection to your Gumroad account.
Limit
Enter the maximum number of products Boost.space Integrator returns during one scenario execution cycle.
Get a Product
Returns the information of a specified product.
Connection
Establish a connection to your Gumroad account.
Product ID
Enter or select the ID of the product you want to retrieve.
Sales
Watch New Sales
Triggers when a product is sold.
Webhook
Select a webhook or add a new one.
See Setting up Gumroad webhooks to add the webhook to your Gumroad account.
List Sales
Returns a list of products.
Connection
Establish a connection to your Gumroad account.
Before
Only return sales after the date you enter. See the list of supported date and time formats.
After
Only return sales before the date you enter. See the list of supported date and time formats.
Enter the email address you want to filter sales by.
Limit
Enter the maximum number of sales Boost.space Integrator returns during one scenario execution cycle.
Get a Sale
Returns the information of a specified sale.
Connection
Establish a connection to your Gumroad account.
Sale ID
Enter or select the ID of the sale you want to retrieve.
Subscriptions
Watch New Cancellations
Triggers when a subscription is canceled.
Webhook
Select a webhook or add a new one.
See Setting up Gumroad webhooks to add the webhook to your Gumroad account.
List Subscribers
Returns a list of subscribers.
Connection
Establish a connection to your Gumroad account.
Product ID
Enter the ID of the product you want to list subscribers from.
Limit
Enter the maximum number of subscribers Boost.space Integrator returns during one scenario execution cycle.
Get a Subscriber
Returns the information of a specified subscriber.
Connection
Establish a connection to your Gumroad account.
Product ID
Enter or select the ID of the product you want to retrieve the subscriber from.
Subscriber ID
Enter or select the ID of the subscriber you want to retrieve.
Other
Create a Product Category
Creates a new variant category on a product.
Connection
Establish a connection to your Gumroad account.
Product ID
Enter or select the ID of the product you want to create a category for.
Title
Enter a title for your new category.
Make an API Call
Performs an arbitrary authorized API call.
Connection
Establish a connection to your Gumroad account.
URL
Enter a path relative to https://api.gumroad.com. For example: /v2/user
For the list of available endpoints, refer to the Gumroad API documentation.
Method
Select the HTTP method you want to use:
GET to retrieve information for an entry.
POST to create a new entry.
PUT to update/replace an existing entry.
PATCH to make a partial entry update.
DELETE to delete an entry.
Headers
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
Example of use – List users
The following API call returns a list of users from your Gumroad account.
URL: /v2/user
Method: GET
Matches of the search can be found in the module’s Output under Bundle > Body > user. Our example returned 1 user:
Setting up Gumroad webhooks
-
In your Boost.space Integrator scenario, select any Gumroad Watch module.
-
Click Add.
-
Give your new webhook a name, then select the connection you want to use.
-
Click Save.
-
Copy the webhook URL to your clipboard.
-
Log in to your Gumroad account.
-
Click Settings, then click Advanced.
-
Paste the webhook URL in the Ping endpoint box.
-
Click Update settings.
You have successfully set up the webhook.
Legacy article, imported from the original Boost.space knowledge base (/knowledge-base/applications/commerce/gumroad/).
