Hotmart is a digital platform that enables creators to sell digital products and online courses. It provides a comprehensive ecosystem for digital product creators, including tools for hosting, payment processing, and managing student access.

Configuring Hotmart as a Source

In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Hotmart option from the list of connectors. Click Next and you’ll be prompted to add your access.

1. Add account access

You’ll need your Hotmart API credentials for this connection. You can obtain these from the Hotmart Developer Portal (check official docs). Once you have them, add the following credentials:

Client ID: The client ID to authenticate against the API service.
Client secret: The client secret to authenticate against the API service.
Token: The basic token to authenticate against the API service. You should pass only the token value without the Basic prefix.
Members area subdomain: The subdomain of your member’s area. It can be extracted from your hotmart.com/club/{subdomain}. The Students stream is only available when this field is filled in.
Start date: Records created or updated after the start date will be extracted from the source.

Under Advanced settings you can also tune how the connector slices date-filtered requests. Each option defaults to 365 days and only needs to be reduced (e.g. 30 or 15) if you keep hitting timeout errors on the corresponding streams:

Sales window (days): Number of days per request window for the Sales History, Sales Commission and Sales Participants streams.
Price details window (days): Number of days per request window for the Price Details stream.
Subscription window (days): Number of days per request window for the Subscriptions and Subscription Transactions streams.

Once you’re done, click Next.

2. Select streams

Choose which data streams you want to sync - you can select all streams or pick specific ones that matter most to you. The available streams include sales history, subscriptions, products, and more.

Tip: The stream can be found more easily by typing its name.

Select the streams and click Next.

3. Configure data streams

Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.

Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
Sync Type: you can choose between INCREMENTAL and FULL_TABLE.
- Incremental: every time the extraction happens, we’ll get only the new data - which is good if, for example, you want to keep every record ever fetched.
- Full table: every time the extraction happens, we’ll get the current state of the data - which is good if, for example, you don’t want to have deleted data in your catalog.

Once you are done configuring, click Next.

4. Configure data source

Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Optionally, you can define some additional settings:

Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
Determine when to execute an Additional Full Sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.

Once you are ready, click Next to finalize the setup.

5. Check your new source

You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.

For you to be able to see it on your Catalog, you need at least one successful source run.

Streams and Fields

Below you’ll find all available data streams from Hotmart and their corresponding fields. Date fields are delivered as the Hotmart API returns them: integer epoch timestamps in milliseconds.

Sales History

Stream containing historical sales data from your Hotmart products.Key Fields:

Field	Type	Description
`id`	String	Unique identifier for the sale (transaction ID)
`product`	Object	Product information
`product.id`	Integer	Product identifier
`product.name`	String	Name of the product
`buyer`	Object	Buyer information
`buyer.name`	String	Name of the buyer
`buyer.ucode`	String	Unique code for the buyer
`buyer.email`	String	Email of the buyer
`producer`	Object	Producer information
`producer.name`	String	Name of the producer
`producer.ucode`	String	Unique code for the producer
`purchase`	Object	Purchase details
`purchase.transaction`	String	Transaction identifier
`purchase.order_date`	Integer	Order date (epoch milliseconds)
`purchase.approved_date`	Integer	Approval date (epoch milliseconds)
`purchase.status`	String	Current status of the sale
`purchase.recurrency_number`	Integer	Recurrence number for subscriptions
`purchase.is_subscription`	Boolean	Whether this is a subscription purchase
`purchase.commission_as`	String	Commission type
`purchase.price.value`	Number	Price value
`purchase.price.currency_code`	String	Currency code
`purchase.payment.method`	String	Payment method
`purchase.payment.installments_number`	Integer	Number of installments
`purchase.payment.type`	String	Payment type
`purchase.tracking.source_sck`	String	Source tracking code (SCK)
`purchase.tracking.source`	String	Traffic source
`purchase.tracking.external_code`	String	External tracking code
`purchase.warranty_expire_date`	Integer	Warranty expiration date (epoch milliseconds)
`purchase.offer.payment_mode`	String	Payment mode
`purchase.offer.code`	String	Offer code
`purchase.hotmart_fee.total`	Number	Total Hotmart fee
`purchase.hotmart_fee.fixed`	Number	Fixed fee amount
`purchase.hotmart_fee.currency_code`	String	Currency code of the fee
`purchase.hotmart_fee.base`	Number	Base fee amount
`purchase.hotmart_fee.percentage`	Number	Fee percentage

Subscriptions

Stream containing information about recurring subscriptions.Key Fields:

Field	Type	Description
`subscriber_code`	String	Code identifying the subscriber
`subscription_id`	Integer	Unique identifier for the subscription
`status`	String	Current status of the subscription
`accession_date`	Integer	Date when the subscription started (epoch milliseconds)
`end_accession_date`	Integer	Date when the subscription ended (epoch milliseconds)
`request_date`	Integer	Date when the subscription was requested (epoch milliseconds)
`date_next_charge`	Integer	Date of the next charge (epoch milliseconds)
`trial`	Boolean	Whether this is a trial subscription
`transaction`	String	Transaction identifier
`plan`	Object	Subscription plan details
`plan.id`	Integer	Plan identifier
`plan.name`	String	Name of the plan
`plan.recurrency_period`	Integer	Period between charges
`plan.max_charge_cycles`	Integer	Maximum number of charge cycles
`product`	Object	Product information
`product.id`	Integer	Product identifier
`product.name`	String	Product name
`product.ucode`	String	Unique product code
`price`	Object	Price information
`price.value`	Number	Price value
`price.currency_code`	String	Currency code
`subscriber`	Object	Subscriber information
`subscriber.name`	String	Subscriber’s name
`subscriber.email`	String	Subscriber’s email
`subscriber.ucode`	String	Unique subscriber code

Subscription Transactions

Stream containing transaction history for subscriptions.Key Fields:

Field	Type	Description
`id`	String	Unique identifier for the transaction
`last_recurrency_start_date`	Integer	Start date of the last recurrence (epoch milliseconds)
`has_unpaid_recurrency`	Boolean	Whether there are unpaid recurrences
`product`	Object	Product information
`product.id`	Integer	Product identifier
`product.name`	String	Product name
`subscriber`	Object	Subscriber information
`subscriber.id`	Integer	Subscriber identifier
`subscriber.name`	String	Subscriber’s name
`subscriber.email`	String	Subscriber’s email
`subscriber.phone`	String	Phone number
`subscriber.phone_ddd`	String	Phone area code
`recurrency`	Object	Recurrence information
`recurrency.number`	Integer	Recurrence number
`recurrency.scheduled_retry`	Integer	Scheduled retry timestamp (epoch milliseconds)
`recurrency.number_list`	String	List of recurrence numbers
`recurrency.transaction_sequence`	Integer	Transaction sequence number
`recurrency.start_datetime`	Integer	Start date and time (epoch milliseconds)
`recurrency.payment_delays_days`	Integer	Days of payment delay
`recurrency.transaction_type`	String	Type of transaction
`recurrency.is_current_purchase`	Boolean	Whether this is the current purchase
`recurrency.has_retry`	Boolean	Whether retries are available
`recurrency.status`	String	Status of the recurrence
`last_recurrency_number`	Integer	Last recurrence number
`trial_info`	Object	Trial information
`trial_info.trial`	Boolean	Whether this is a trial
`trial_info.trial_end`	Integer	Trial end date (epoch milliseconds)
`trial_info.trial_period`	Integer	Trial period duration
`purchase`	Object	Purchase information
`purchase.transaction`	String	Transaction identifier
`purchase.status`	String	Transaction status
`purchase.order_date`	Integer	Order date (epoch milliseconds)
`purchase.approved_date`	Integer	Approval date (epoch milliseconds)
`purchase.price.value`	Number	Base price value
`purchase.price.total_value`	Number	Total price value
`purchase.price.currency`	String	Currency code
`purchase.installment.installment_number`	Integer	Number of installments
`purchase.installment.installment_type`	String	Type of installment
`purchase.payment.payment_type`	String	Type of payment
`purchase.payment.credit_card_flag`	String	Credit card brand
`purchase.payment.refusal_message`	String	Payment refusal message
`purchase.payment.refund_chargeback_date`	Integer	Refund or chargeback date (epoch milliseconds)
`purchase.payment.billet_expiration_date`	Integer	Bank slip expiration date (epoch milliseconds)
`purchase.payment.billet_recovery_type`	String	Bank slip recovery type
`purchase.payment.billet_reprint_code`	String	Bank slip reprint code
`purchase.payment.pix_expiration_date`	Integer	PIX expiration date (epoch milliseconds)
`purchase.commission.original_value`	Number	Original commission value
`purchase.commission.original_paid_value`	Number	Original paid value
`purchase.commission.producer_value`	Number	Producer’s commission value
`purchase.commission.producer_paid_value`	Number	Amount paid to the producer
`purchase.commission.currency`	String	Currency code
`purchase.commission.conversion_rate`	Number	Conversion rate
`cancellation_date`	Integer	Cancellation date (epoch milliseconds)
`is_paid_anticipation`	Boolean	Whether payment was anticipated
`max_cycles`	Integer	Maximum number of cycles
`adoption_date`	Integer	Adoption date (epoch milliseconds)
`subscriber_code`	String	Subscriber’s code
`date_next_charge`	Integer	Next charge date (epoch milliseconds)
`is_paid_negotiation`	Boolean	Whether payment was negotiated
`last_update`	Integer	Last update timestamp (epoch milliseconds)
`billing_type`	String	Type of billing
`producer`	Object	Producer information
`producer.name`	String	Producer’s name
`subscription_id`	Integer	Subscription identifier
`has_credit_card_change`	Boolean	Whether credit card was changed
`plan`	Object	Plan information
`plan.name`	String	Plan name
`plan.recurrency_period`	Integer	Period between recurrences
`plan.recurrency_type`	String	Type of recurrence
`plan.coupon_code`	String	Applied coupon code
`plan.offer.code`	String	Offer code
`plan.offer.key`	String	Offer key
`plan.offer.description`	String	Offer description
`status`	String	Overall status

Sales Commission

Stream containing commission information for sales.Key Fields:

Field	Type	Description
`transaction`	String	Unique identifier for the transaction
`product`	Object	Product information
`product.id`	Integer	Product identifier
`product.name`	String	Name of the product
`exchange_rate_currency_payout`	Number	Exchange rate for currency payout
`commissions`	Array	Array of commission information
`commissions[].commission.value`	Number	Commission amount
`commissions[].commission.currency_value`	String	Currency of the commission
`commissions[].user.ucode`	String	Unique code of the commissioned user
`commissions[].user.name`	String	Name of the commissioned user
`commissions[].source`	String	Source of the commission

Sales Participants

Stream containing information about participants in sales transactions.Key Fields:

Field	Type	Description
`transaction`	String	Unique identifier for the transaction
`product`	Object	Product information
`product.id`	Integer	Product identifier
`product.name`	String	Name of the product
`users`	Array	Array of user information
`users[].role`	String	Role of the user in the transaction
`users[].user.ucode`	String	Unique user code
`users[].user.name`	String	User’s name
`users[].user.trade_name`	String	User’s trade name
`users[].user.email`	String	Email address
`users[].user.phone`	String	Phone number
`users[].user.cellphone`	String	Cellphone number
`users[].user.locale`	String	User’s locale
`users[].user.documents`	Array	Array of document information
`users[].user.documents[].type`	String	Document type
`users[].user.documents[].value`	String	Document value
`users[].user.address.address`	String	Street address
`users[].user.address.number`	String	Street number
`users[].user.address.complement`	String	Address complement
`users[].user.address.neighborhood`	String	Neighborhood
`users[].user.address.city`	String	City
`users[].user.address.state`	String	State
`users[].user.address.country`	String	Country
`users[].user.address.zip_code`	String	ZIP code

Price Details

Stream containing detailed pricing information for products.Key Fields:

Field	Type	Description
`transaction`	String	Unique identifier for the transaction
`product`	Object	Product information
`product.id`	Integer	Product identifier
`product.name`	String	Product name
`base`	Object	Base price information
`base.value`	Number	Base price value
`base.currency_code`	String	Currency code
`total`	Object	Total price information
`total.value`	Number	Total price value
`total.currency_code`	String	Currency code
`vat`	Object	VAT information
`vat.value`	Number	VAT amount
`vat.currency_code`	String	Currency code
`fee`	Object	Fee information
`fee.value`	Number	Fee amount
`fee.currency_code`	String	Currency code
`coupon`	Object	Coupon information
`coupon.code`	String	Coupon code
`coupon.value`	Number	Coupon value
`real_conversion_rate`	Number	Real currency conversion rate

Products

Stream containing information about your Hotmart products.Key Fields:

Field	Type	Description
`id`	Integer	Unique identifier for the product
`name`	String	Name of the product
`ucode`	String	Unique product code
`status`	String	Current status of the product
`created_at`	Integer	Creation date (epoch milliseconds)
`format`	String	Product format
`is_subscription`	Boolean	Whether the product is a subscription
`warranty_period`	Integer	Warranty period in days

Coupons

Stream containing the discount coupons configured for each of your products. Coupons are fetched per product, so this stream depends on the Products stream.Key Fields:

Field	Type	Description
`id`	Integer	Unique identifier for the coupon
`coupon_code`	String	Coupon code
`active`	Boolean	Whether the coupon is active
`status`	String	Current status of the coupon
`discount`	Number	Discount applied by the coupon
`start_date`	Integer	Date from which the coupon is valid (epoch milliseconds)
`time_zone`	Object	Time zone in which the coupon dates are defined
`time_zone.id`	String	Time zone identifier
`time_zone.name`	String	Time zone name
`time_zone.offset`	String	Time zone offset
`time_zone.description`	String	Time zone description

Students

Stream containing information about students enrolled in your products. This stream is only available when the Members area subdomain is configured.Key Fields:

Field	Type	Description
`user_id`	String	Unique identifier for the student
`engagement`	String	Student’s engagement level
`name`	String	Student’s name
`email`	String	Student’s email
`last_access_date`	Integer	Last access timestamp (epoch milliseconds)
`role`	String	Student’s role
`first_access_date`	Integer	First access timestamp (epoch milliseconds)
`locale`	String	Student’s locale
`plus_access`	String	Plus access status
`progress`	Object	Progress information
`progress.completed_percentage`	Integer	Percentage of completion
`progress.total`	Integer	Total number of items
`progress.completed`	Integer	Number of completed items
`status`	String	Current status
`access_count`	Integer	Number of accesses
`is_deletable`	Boolean	Whether the student can be deleted
`class_id`	String	Class identifier
`type`	String	Student type

Implementation Notes

API Pagination & Limits

Windowed Pagination: To prevent timeouts and improve reliability when extracting large amounts of historical data, the date-filtered streams (Sales History, Sales Commission, Sales Participants, Subscriptions, Subscription Transactions and Price Details) utilize windowed pagination. The connector requests data in yearly (365-day) blocks starting from your configured Start Date up to the current date. The block size of each stream group can be changed through the Sales window, Price details window and Subscription window advanced settings.
Automatic Window Shrinking (504 Gateway Timeout handling): The Hotmart API can return 504 Gateway Timeout errors when a single window holds too much data. When that happens on any of the windowed streams above, the connector automatically halves the current extraction window (e.g. 365 → 182 → 91 → 45 → 30 days), rebuilds the request for the same period and retries. The reduced window is kept for the rest of the run. Only when the window is already at the minimum of 30 days and the API still times out does the stream fail, with a message pointing to the corresponding window setting.
Rate Limiting: Requests are throttled to the Hotmart API limit and, when a 429 Too Many Requests response is received, the connector waits for the period indicated by the API before retrying automatically.

Skills for agents

Download Hotmart skills file

Hotmart connector documentation as plain markdown, for use in AI agent contexts.

Documentation

Get started

Context

Activate

Workspace

Resources

Hotmart as a data source

Configuring Hotmart as a Source

1. Add account access

2. Select streams

3. Configure data streams

4. Configure data source

5. Check your new source

Streams and Fields

Implementation Notes

Skills for agents

Download Hotmart skills file

​Configuring Hotmart as a Source

​1. Add account access

​2. Select streams

​3. Configure data streams

​4. Configure data source

​5. Check your new source

​Streams and Fields

​Implementation Notes

​API Pagination & Limits

​Skills for agents

Download Hotmart skills file

Configuring Hotmart as a Source

1. Add account access

2. Select streams

3. Configure data streams

4. Configure data source

5. Check your new source

Streams and Fields

Implementation Notes

API Pagination & Limits

Skills for agents