Hotmart icon

Hotmart

Manage Hotmart products, subscriptions, sales, payment links, coupons, and members-area content, and react to purchase, subscription, and club events.

9 triggers23 searches29 actionsInstant (webhooks)Auth: OAuth

AI-assisted documentation23 min read

This documentation is compiled from our integration source code, internal specs for Hotmart, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Hotmart on WEXTL →

Hotmart requires an active account and OAuth client credentials, granted by signing in with your account to connect — both are set up on its own site.[3]

You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.

  • Client IDtextRequired

    From Hotmart → Tools → Developer Credentials → your credential's Client ID.

    [1]
  • Client SecretpasswordRequired

    The Client Secret shown alongside your Client ID when the credential was created.

    [1]
  • Basic TokenpasswordRequired

    The third value Hotmart generates with your Client ID/Secret, labeled "Basic" on the credentials page.

    [1]
  • EnvironmentselectRequired

    Use Sandbox to test against Hotmart's fictitious test data. Must match the type selected when the credential was created.

    [1]
  1. Log in to your WEXTL account, add the Hotmart node module to your workflow, and click Create new credential.
    Instant triggers use webhooks — click Create a webhook first when adding one, then create the credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Hotmart account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Watch Cart AbandonmentsTrigger
Output fields[3]
FieldType
Affiliateboolean
Productobject
IDnumber
Nametext
Buyerobject
Nametext
Emailtext
Phonetext
Offerobject
Codetext
Checkout Countryobject
Nametext
ISOtext
Watch Club First AccessTrigger
Output fields[3]
FieldType
Productobject
IDnumber
Nametext
Userobject
Nametext
Emailtext
Watch Club Module CompletionsTrigger
Output fields[3]
FieldType
Productobject
IDnumber
Nametext
Userobject
Nametext
Emailtext
Moduleobject
IDtext
Nametext
Watch Order Fulfillment EventsTrigger
Output fields[3]
FieldType
Purchaseobject
Full Priceobject
Priceobject
Approved Datenumber
Order Datenumber
IDnumber
Transactiontext
Statustext
Shopperobject
Line Itemsarray
Deliveryobject
Shipping Processing Timenumber
Method Typetext
Delivery Timenumber
Destinationobject
Shippingobject
Shipping Total Valueobject
Carrierobject
Shipping Logistics Timenumber
Carrier Optionsobject
Typetext
Estimate Shipping Costobject
Shipping Markup Priceobject
Fulfillment Serviceobject
Service Typetext
Billingobject
Countrytext
Phonetext
Documenttext
Nametext
Time Zonetext
Localetext
Ucodetext
Emailtext
Addressobject
Watch Physical Product EventsTrigger
Output fields[3]
FieldType
Eventtext
Productobject
Product Ucodetext
Product Nametext
Watch Plan SwitchesTrigger
Output fields[3]
FieldType
Switch Plan Datenumber
Subscriptionobject
Subscriber Codetext
Statustext
Date Next Chargenumber
Productobject
Userobject
Plansarray
Watch Purchase EventsTrigger
Output fields[3]
FieldType
Productobject
IDnumber
Ucodetext
Nametext
Has Co-productionboolean
Warranty Datetext
Support Emailtext
Is Physical Productboolean
SKUtext
External IDtext
Contentobject
Affiliatesarray
Buyerobject
Ucodetext
Emailtext
Nametext
First Nametext
Last Nametext
Checkout Phonetext
Checkout Phone Codetext
Documenttext
Document Typetext
Addressobject
Producerobject
Nametext
Legal Naturetext
Documenttext
Commissionsarray
Purchaseobject
Approved Datenumber
Full Priceobject
Original Offer Priceobject
Priceobject
Offerobject
Recurrence Numbernumber
Subscription Anticipation Purchaseboolean
Checkout Countryobject
Originobject
Order Bumpobject
Shippingobject
Costobject
Estimated Delivery Daysnumber
Carrierobject
Fulfillmentobject
FlexPay Planobject
Checkout Keytext
Origin Featuretext
Signup Transaction Referencetext
Enrollment Statustext
Next Billing Datetext
Plan Chargesarray
Subscriptionobject
Statustext
Planobject
Subscriberobject
Watch Subscription CancellationsTrigger
Output fields[3]
FieldType
Date Next Chargenumber
Productobject
Nametext
IDnumber
Actual Recurrence Valuenumber
Subscriberobject
Codetext
Nametext
Emailtext
Phoneobject
Subscriptionobject
IDnumber
Planobject
Cancellation Datenumber
Watch Subscription Charge Date ChangesTrigger
Output fields[3]
FieldType
Subscriberobject
Nametext
Emailtext
Codetext
Subscriptionobject
Productobject
Old Charge Daynumber
New Charge Daynumber
Date Next Chargetext
Statustext
Planobject
Offerobject
Nametext
IDnumber
Get Account InfoSearch
Input fields[3]
FieldType
Filter FieldRequired
choice
Filter ValueRequired
text
Output fields[3]
FieldType
Nametext
Ucodetext
Emailtext
Entity Typetext
Legal Nametext
Mother Nametext
Birth Datetext
Countrytext
Doc Typetext
Doc Valuetext
Documentsarray
Address Citytext
Address Streettext
Address Numbertext
Address Complementtext
Address Statetext
Partnersarray
Get Event InfoSearch
Input fields[3]
FieldType
Event IDRequired
text
Output fields[3]
FieldType
Productobject
Nametext
IDnumber
Start Event Datenumber
End Event Datenumber
Lotsarray
Get Product OffersSearch
Input fields[3]
FieldType
ProductRequired
choice
LimitRequired
number
Page Tokentext
Output fields[3]
FieldType
Codetext
Nametext
Descriptiontext
Priceobject
Valuenumber
Currency Codetext
Payment Modetext
Currency Conversion Enabledboolean
Smart Recovery Enabledboolean
Is Main Offerboolean
Get Product PlansSearch
Input fields[3]
FieldType
ProductRequired
choice
LimitRequired
number
Page Tokentext
Output fields[3]
FieldType
Codetext
Nametext
Descriptiontext
Priceobject
Currency Codetext
Valuenumber
Periodicitytext
Max Installmentsnumber
Payment Modetext
Trial Period (Days)number
Subscription Recovery Enabledboolean
Switch Plan Enabledboolean
Get Sales Price BreakdownSearch
Input fields[3]
FieldType
LimitRequired
number
Page Tokentext
Productchoice
Start Datedate
End Datedate
Transactiontext
Transaction Statuschoice
Payment Typechoice
Output fields[3]
FieldType
Transactiontext
Productobject
IDnumber
Nametext
Baseobject
Valuenumber
Currency Codetext
Totalobject
Valuenumber
Currency Codetext
VATobject
Valuenumber
Currency Codetext
Feeobject
Valuenumber
Currency Codetext
Couponobject
Codetext
Valuenumber
Real Conversion Ratenumber
Get Sales SummarySearch
Input fields[3]
FieldType
LimitRequired
number
Page Tokentext
Productchoice
Start Datedate
End Datedate
Sales Sourcetext
Affiliate Nametext
Payment Typechoice
Offer Codetext
Transactiontext
Transaction Statuschoice
Output fields[3]
FieldType
Total Itemsnumber
Total Valueobject
Valuenumber
Currency Codetext
Get Student ProgressSearch
Input fields[3]
FieldType
SubdomainRequired
text
StudentRequired
choice
Output fields[3]
FieldType
Page IDtext
Page Nametext
Module Nametext
Is Module Extraboolean
Is Completedboolean
Completed Datenumber
Get Subscriber's PurchasesSearch
Input fields[3]
FieldType
SubscriberRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Transactiontext
Approved Datenumber
Payment Enginetext
Statustext
Priceobject
Valuenumber
Currency Codetext
Payment Typetext
Payment Methodtext
Recurrency Numbernumber
Under Warrantyboolean
Purchase Subscriptionboolean
Get Subscription SummarySearch
Input fields[3]
FieldType
LimitRequired
number
Page Tokentext
Productchoice
Subscriber Codetext
Accession Date Fromdate
Accession Date Untildate
Next Charge Date Fromdate
Output fields[3]
FieldType
Subscriber Codetext
Subscription IDnumber
Statustext
Lifetime (Days)number
Accession Datenumber
End Accession Datenumber
Trialboolean
Planobject
Nametext
Recurrency Periodnumber
Productobject
Nametext
IDnumber
Offerobject
Codetext
Last Recurrencyobject
Numbernumber
Request Datenumber
Statustext
Transaction Numbernumber
Billing Typetext
Unpaid Recurrenciesarray
Subscriberobject
Nametext
IDnumber
Emailtext
Get Subscription TransactionsSearch
Input fields[3]
FieldType
LimitRequired
number
Page Tokentext
Product IDnumber
Transactiontext
Subscriber Nametext
Subscriber Emailtext
Billing Typechoice
Subscription Statuschoice
Recurrency Statuschoice
Purchase Statustext
Transaction Date Fromdate
Transaction Date Untildate
Offer Codetext
Purchase Payment Typechoice
Subscriber Codetext
Output fields[3]
FieldType
Subscription IDnumber
Last Updatenumber
Subscriber Codetext
Statustext
Billing Typetext
Adoption Datenumber
Next Charge Datenumber
Last Recurrency Start Datenumber
Cancellation Datenumber
Max Cyclesnumber
Last Recurrency Numbernumber
Has Unpaid Recurrencyboolean
Has Credit Card Changeboolean
Is Paid Anticipationboolean
Is Paid Negotiationboolean
Productobject
IDnumber
Nametext
Trial Infoobject
Trialboolean
Trial Periodnumber
Trial Endnumber
Planobject
Nametext
Recurrency Periodnumber
Recurrency Typetext
Coupon Codetext
Offerobject
Recurrencyobject
Statustext
Numbernumber
Start Datetimenumber
Payment Delays Daysnumber
Transaction Typetext
Number Listtext
Transaction Sequencenumber
Is Current Purchaseboolean
Has Retryboolean
Scheduled Retrynumber
Purchaseobject
Transactiontext
Order Datenumber
Approved Datenumber
Statustext
Paymentobject
Installmentobject
Priceobject
Commissionobject
2other output fields
Get User ProfileSearch
Output fields[3]
FieldType
IDnumber
Nametext
Emailtext
Logintext
Ucodetext
Phone Area Codetext
Phonetext
Profile Photo URLurl
Addressobject
Streettext
Numbertext
Complementtext
Neighborhoodtext
Citytext
Statetext
Zip Codetext
Countrytext
Entity Typetext
Localetext
Commission Currencytext
Time Zonetext
List Club ModulesSearch
Input fields[3]
FieldType
SubdomainRequired
text
Extra Modules Onlyboolean
Output fields[3]
FieldType
Module IDtext
Nametext
Sequencenumber
Is Publicboolean
Is Extraboolean
Is Extra Paidboolean
Class IDsarray
Total Pagesnumber
List Club PagesSearch
Input fields[3]
FieldType
SubdomainRequired
text
ModuleRequired
choice
Product IDRequired
number
Output fields[3]
FieldType
Page IDtext
Nametext
Typetext
Page Ordernumber
Total Commentsnumber
Ratesarray
Rates Averagenumber
Publishedboolean
Has Mediaboolean
Dripping Configsarray
List Club StudentsSearch
Input fields[3]
FieldType
SubdomainRequired
text
LimitRequired
number
Emailemail
Page Tokentext
Output fields[3]
FieldType
User IDtext
Nametext
Emailemail
Roletext
Last Access Datenumber
First Access Datenumber
Localetext
Plus Accesstext
Progressobject
Completed Percentagenumber
Totalnumber
Completednumber
Statustext
Purchase Datenumber
Access Countnumber
Is Deletableboolean
Class IDtext
Typetext
Engagementtext
List CouponsSearch
Input fields[3]
FieldType
ProductRequired
choice
LimitRequired
number
Codetext
Page Tokentext
Output fields[3]
FieldType
IDnumber
Coupon Codetext
Discountnumber
Statustext
Activeboolean
Start Datenumber
Time Zoneobject
IDtext
Nametext
Descriptiontext
Offsettext
List Event TicketsSearch
Input fields[3]
FieldType
Event IDRequired
text
LimitRequired
number
Buyer Emailemail
Participant Emailemail
Last Updatedate
Lot IDnumber
Ticket Statuschoice
Ticket Typechoice
Check-in Statuschoice
E-Ticket IDnumber
Ticket QR Codetext
Page Tokentext
Output fields[3]
FieldType
Buyerobject
Ucodetext
Nametext
Emailemail
Participantobject
IDnumber
Nametext
Emailemail
Documenttext
Phonenumber
E-Ticketobject
Ticket QR Codetext
Current Updatenumber
Check-in Statustext
Is Blockedboolean
Ticket Statustext
Ticket Typetext
IDnumber
Check-in URLurl
Lotobject
IDnumber
Nametext
Productobject
IDnumber
Nametext
List Payment LinksSearch
List ProductsSearch
Input fields[3]
FieldType
LimitRequired
number
Product IDnumber
Statuschoice
Formatchoice
Page Tokentext
Output fields[3]
FieldType
IDnumber
Nametext
Ucodetext
Statustext
Created Atnumber
Formattext
Is Subscriptionboolean
Warranty Periodnumber
List SalesSearch
Input fields[3]
FieldType
LimitRequired
number
Page Tokentext
Productchoice
Start Datedate
End Datedate
Sales Sourcetext
Transactiontext
Buyer Nametext
Buyer Emailemail
Transaction Statuschoice
Payment Typechoice
Offer Codetext
Commission Aschoice
Output fields[3]
FieldType
Productobject
Nametext
IDnumber
Buyerobject
Nametext
Ucodetext
Emailtext
Producerobject
Nametext
Ucodetext
Purchaseobject
Transactiontext
Order Datenumber
Approved Datenumber
Statustext
Recurrency Numbernumber
Is Subscriptionboolean
Commission Astext
Priceobject
Paymentobject
Trackingobject
List Sales CommissionsSearch
Input fields[3]
FieldType
LimitRequired
number
Page Tokentext
Productchoice
Start Datedate
End Datedate
Transactiontext
Commission Aschoice
Transaction Statuschoice
Output fields[3]
FieldType
Transactiontext
Productobject
Nametext
IDnumber
Exchange Rate Currency Payoutnumber
Commissionsarray
List Sales ParticipantsSearch
Input fields[3]
FieldType
LimitRequired
number
Page Tokentext
Productchoice
Start Datedate
End Datedate
Buyer Emailemail
Sales Sourcetext
Transactiontext
Buyer Nametext
Affiliate Nametext
Commission Aschoice
Transaction Statuschoice
Output fields[3]
FieldType
Transactiontext
Productobject
Nametext
IDnumber
Usersarray
List SubscriptionsSearch
Input fields[3]
FieldType
LimitRequired
number
Page Tokentext
Productchoice
Plan Namesarray
Plan IDnumber
Accession Date Fromdate
Accession Date Untildate
Statuschoice
Subscriber Codetext
Subscriber Emailtext
Transactiontext
Trialboolean
Cancelation Date Fromdate
Cancelation Date Untildate
Next Charge Date Fromdate
Next Charge Date Untildate
Output fields[3]
FieldType
Subscriber Codetext
Subscription IDnumber
Statustext
Accession Datenumber
End Accession Datenumber
Request Datenumber
Next Charge Datenumber
Trialboolean
Transactiontext
Planobject
Nametext
IDnumber
Recurrency Periodnumber
Max Charge Cyclesnumber
Productobject
IDnumber
Nametext
Ucodetext
Priceobject
Valuenumber
Currency Codetext
Subscriberobject
Nametext
Emailtext
Ucodetext
List Switchable PlansSearch
Input fields[3]
FieldType
Subscriberschoice
Productchoice
Offer Codesarray
LimitRequired
number
Output fields[3]
FieldType
Subscriber Codetext
Recurrencyobject
Numbernumber
Next Charge Datenumber
Subscriberobject
Emailtext
Nametext
Statustext
Productobject
Nametext
Plansarray
Add Shipment Tracking EventAction
Input fields[3]
FieldType
PartnerRequired
object
Partner IdentifierRequired
text
TransactionRequired
text
Tracking EventsRequired
array
Tracking Eventobject
Tracking Codetext
Tracking URLurl
Carriertext
Carrier Servicetext
Shipping Typechoice
Estimated Deliverydate
Actual Deliverydate
Actual Freight Pricenumber
Recipient Emailemail
Is Sampleboolean
Order Returned Ondate
Reason For Returntext
Cancel SubscriptionAction
Input fields[3]
FieldType
SubscriberRequired
choice
Send Cancellation EmailRequired
boolean
Output fields[3]
FieldType
Statustext
Subscriber Codetext
Creation Datetext
Current Recurrencenumber
Date Last Recurrencetext
Next Charge Datetext
Due Daynumber
Trial Periodnumber
Interval Type Between Chargestext
Interval Between Chargesnumber
Max Charge Cyclesnumber
Activation Datetext
Shopperobject
Emailtext
Phonetext
Cancel SubscriptionsAction
Input fields[3]
FieldType
SubscribersRequired
choice
Send Cancellation EmailRequired
boolean
Output fields[3]
FieldType
Success Subscriptionsarray
Fail Subscriptionsarray
Change Subscription Charge DayAction
Input fields[3]
FieldType
SubscriberRequired
choice
Due DayRequired
number
Charge Payment Token by OfferAction
Input fields[3]
FieldType
Payment TokenRequired
text
SCKRequired
text
Offer CodeRequired
text
Charge Payment Token by ValueAction
Input fields[3]
FieldType
Payment TokenRequired
text
SCKRequired
text
ValueRequired
number
Create CouponAction
Input fields[3]
FieldType
ProductRequired
choice
CodeRequired
text
DiscountRequired
number
Start Datedate
End Datedate
Affiliate IDnumber
Offer IDsarray
Create Payment LinkAction
Create Payment Link OfferAction
Input fields[3]
FieldType
Payment LinkRequired
choice
Offer NameRequired
text
ValueRequired
number
CurrencyRequired
choice
Is Main Offerboolean
Output fields[3]
FieldType
Ucodetext
Nametext
Offer Codetext
Offer Nametext
URLurl
Create Payment Link PlanAction
Input fields[3]
FieldType
Payment LinkRequired
choice
NameRequired
text
ValueRequired
number
Currencychoice
Periodicitychoice
Billing Configurationobject
Billing Typechoice
Max Number of Paymentsnumber
Trialobject
Trial Typechoice
Trial Period (Days)number
Output fields[3]
FieldType
Plan Nametext
Plan Codetext
Ucodetext
URLurl
Create Physical ProductAction
Input fields[3]
FieldType
NameRequired
text
DescriptionRequired
text
CategoryRequired
number
DimensionsRequired
object
Weight (kg)Required
number
Width (cm)Required
number
Height (cm)Required
number
Length (cm)Required
number
PartnerRequired
object
Partner IdentifierRequired
text
Partner URLurl
Content Localetext
Subcategorynumber
Free Shippingboolean
Statuschoice
SKUtext
Costnumber
Imageobject
Image IDnumber
Image URLurl
Addressobject
Postal Codetext
Address Numbertext
Streettext
Complementtext
Neighborhoodtext
Citytext
Statetext
Countrytext
Additional Shipping Daysnumber
Output fields[3]
FieldType
Ucodetext
SKUtext
Product URLurl
Create Physical Product with Variants (V2)Action
Input fields[3]
FieldType
NameRequired
text
DescriptionRequired
text
CategoryRequired
number
DimensionsRequired
object
Weight (kg)Required
number
Width (cm)Required
number
Height (cm)Required
number
Length (cm)Required
number
AttributesRequired
array
Attributeobject
VariantsRequired
array
Variantobject
PartnerRequired
object
Partner IdentifierRequired
text
Partner URLurl
Partner Product IDtext
Content Localetext
Subcategorynumber
Free Shippingboolean
Statuschoice
SKUtext
Costnumber
Imageobject
Image IDnumber
Image URLurl
Addressobject
Postal Codetext
Address Numbertext
Streettext
Complementtext
Neighborhoodtext
Citytext
Statetext
Countrytext
Additional Shipping Daysnumber
Output fields[3]
FieldType
Ucodetext
SKUtext
Product URLurl
Delete CouponAction
Input fields[3]
FieldType
ProductRequired
choice
Delete Partner Credential LinkAction
Generate Bank Payment SlipAction
Input fields[3]
FieldType
TransactionRequired
text
Output fields[3]
FieldType
Billet URLurl
Generate Installment NegotiationAction
Input fields[3]
FieldType
Subscription IDRequired
number
RecurrencesRequired
array
Recurrencenumber
Payment TypeRequired
choice
Discountobject
TypeRequired
choice
ValueRequired
number
Documenttext
Output fields[3]
FieldType
Subscription IDnumber
Transactiontext
Paymentobject
Typetext
Expiration Datenumber
Billet URLurl
Billet Barcodetext
Pix Codetext
Pix QR Codeurl
Make an API Calluniversal
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber
Reactivate SubscriptionAction
Input fields[3]
FieldType
SubscriberRequired
choice
Charge NowRequired
boolean
Output fields[3]
FieldType
Statustext
Subscriber Codetext
Creation Datetext
Interval Between Chargesnumber
Shopperobject
Emailtext
Phonetext
Reactivate SubscriptionsAction
Input fields[3]
FieldType
SubscribersRequired
choice
Charge NowRequired
boolean
Output fields[3]
FieldType
Success Subscriptionsarray
Fail Subscriptionsarray
Refund SaleAction
Input fields[3]
FieldType
TransactionRequired
text
Register Partner Credential LinkAction
Set Physical Product Sales StatusAction
Input fields[3]
FieldType
Product UcodeRequired
text
PartnerRequired
object
Partner IdentifierRequired
text
StatusRequired
choice
Set Product Email NotificationsAction
Input fields[3]
FieldType
ProductRequired
choice
Allow Transactional EmailsRequired
boolean
Output fields[3]
FieldType
Product IDnumber
Allow Transactional Emailsboolean
Switch Subscription PlanAction
Input fields[3]
FieldType
SubscriberRequired
choice
New Offer CodeRequired
text
Output fields[3]
FieldType
Subscriber Codetext
Statustext
Offer Codetext
Update Partner Credential LinkAction
Update Physical ProductAction
Input fields[3]
FieldType
Product UcodeRequired
text
NameRequired
text
DescriptionRequired
text
CategoryRequired
number
DimensionsRequired
object
Weight (kg)Required
number
Width (cm)Required
number
Height (cm)Required
number
Length (cm)Required
number
PartnerRequired
object
Partner IdentifierRequired
text
Partner URLurl
Content Localetext
Subcategorynumber
Free Shippingboolean
SKUtext
Costnumber
Imageobject
Image IDnumber
Image URLurl
Addressobject
Postal Codetext
Address Numbertext
Streettext
Complementtext
Neighborhoodtext
Citytext
Statetext
Countrytext
Additional Shipping Daysnumber
Update Physical Product VariantsAction
Input fields[3]
FieldType
Product UcodeRequired
text
Partner IdentifierRequired
text
VariantsRequired
array
Variantobject
Attributesarray
Attributeobject
Output fields[3]
FieldType
Attributesarray
Variantsarray
Update Physical Product WebhookAction
Input fields[3]
FieldType
Webhook IDRequired
text
EventsRequired
choice
URLRequired
url
PartnerRequired
object
Partner IdentifierRequired
text
Output fields[3]
FieldType
IDtext
Productobject
Product Ucodetext
Product Nametext
Eventsarray
URLurl
Update Shipment StatusAction
Input fields[3]
FieldType
PartnerRequired
object
Partner IdentifierRequired
text
TransactionRequired
text
StatusRequired
choice
DateRequired
date

Look for Hotmart templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Hotmart Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Hotmart.
  4. WEXTL® visual workflow builder data.

Last updated: Sep 5, 2026 10:02