• Documentation >
• Apps >
• Commerce >
• Gumroad

Gumroad

With Gumroad modules in Ibexa Connect, 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.

Note

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory.

Connecting Gumroad to Ibexa Connect

1. Go to your Ibexa Connect scenario and select the Gumroad module you want to use.

2. Under Connection, click Add.

3. Give your new connection a name.

4. Click Save.

5. A prompt from gumroad.com appears. Log in to your Gumroad account.

6. Click Authorize.

You have successfully established the connection.

Products

List Products

Returns a list of products.

Limit	Enter the maximum number of products Ibexa Connect returns during one scenario execution cycle.

Get a Product

Returns the information of a specified product.

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.

Note

See Setting up Gumroad webhooks to add the webhook to your Gumroad account.

List Sales

Returns a list of products.

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.
Email	Enter the email address you want to filter sales by.
Limit	Enter the maximum number of sales Ibexa Connect returns during one scenario execution cycle.

Get a Sale

Returns the information of a specified sale.

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.

Note

See Setting up Gumroad webhooks to add the webhook to your Gumroad account.

List Subscribers

Returns a list of subscribers.

Product ID	Enter the ID of the product you want to list subscribers from.
Limit	Enter the maximum number of subscribers Ibexa Connect returns during one scenario execution cycle.

Get a Subscriber

Returns the information of a specified subscriber.

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.

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.

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

1. In your Ibexa Connect scenario, select any Gumroad Watch module.

2. Click Add.

3. Give your new webhook a name, then select the connection you want to use.

4. Click Save.

5. Copy the webhook URL to your clipboard.

6. Log in to your Gumroad account.

7. Click Settings, then click Advanced.

   

8. Paste the webhook URL in the Ping endpoint box.

9. Click Update settings.

You have successfully set up the webhook.