Requirements
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]
Get your Hotmart credentials
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]
Connect Hotmart in WEXTL
- 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.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Hotmart account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- 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 →
Hotmart node modules
The list below is a reference of every Hotmart node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Browse every Hotmart node module below — each one opens to show its input parameters, outputs, and connection requirements.
Watch Cart AbandonmentsTrigger
| Field | Type |
|---|---|
| Affiliate | boolean |
| Product | object |
| ID | number |
| Name | text |
| Buyer | object |
| Name | text |
| text | |
| Phone | text |
| Offer | object |
| Code | text |
| Checkout Country | object |
| Name | text |
| ISO | text |
Watch Club First AccessTrigger
| Field | Type |
|---|---|
| Product | object |
| ID | number |
| Name | text |
| User | object |
| Name | text |
| text |
Watch Club Module CompletionsTrigger
| Field | Type |
|---|---|
| Product | object |
| ID | number |
| Name | text |
| User | object |
| Name | text |
| text | |
| Module | object |
| ID | text |
| Name | text |
Watch Order Fulfillment EventsTrigger
| Field | Type |
|---|---|
| Purchase | object |
| Full Price | object |
| Price | object |
| Approved Date | number |
| Order Date | number |
| ID | number |
| Transaction | text |
| Status | text |
| Shopper | object |
| Line Items | array |
| Delivery | object |
| Shipping Processing Time | number |
| Method Type | text |
| Delivery Time | number |
| Destination | object |
| Shipping | object |
| Shipping Total Value | object |
| Carrier | object |
| Shipping Logistics Time | number |
| Carrier Options | object |
| Type | text |
| Estimate Shipping Cost | object |
| Shipping Markup Price | object |
| Fulfillment Service | object |
| Service Type | text |
| Billing | object |
| Country | text |
| Phone | text |
| Document | text |
| Name | text |
| Time Zone | text |
| Locale | text |
| Ucode | text |
| text | |
| Address | object |
Watch Physical Product EventsTrigger
| Field | Type |
|---|---|
| Event | text |
| Product | object |
| Product Ucode | text |
| Product Name | text |
Watch Plan SwitchesTrigger
| Field | Type |
|---|---|
| Switch Plan Date | number |
| Subscription | object |
| Subscriber Code | text |
| Status | text |
| Date Next Charge | number |
| Product | object |
| User | object |
| Plans | array |
Watch Purchase EventsTrigger
| Field | Type |
|---|---|
| Product | object |
| ID | number |
| Ucode | text |
| Name | text |
| Has Co-production | boolean |
| Warranty Date | text |
| Support Email | text |
| Is Physical Product | boolean |
| SKU | text |
| External ID | text |
| Content | object |
| Affiliates | array |
| Buyer | object |
| Ucode | text |
| text | |
| Name | text |
| First Name | text |
| Last Name | text |
| Checkout Phone | text |
| Checkout Phone Code | text |
| Document | text |
| Document Type | text |
| Address | object |
| Producer | object |
| Name | text |
| Legal Nature | text |
| Document | text |
| Commissions | array |
| Purchase | object |
| Approved Date | number |
| Full Price | object |
| Original Offer Price | object |
| Price | object |
| Offer | object |
| Recurrence Number | number |
| Subscription Anticipation Purchase | boolean |
| Checkout Country | object |
| Origin | object |
| Order Bump | object |
| Shipping | object |
| Cost | object |
| Estimated Delivery Days | number |
| Carrier | object |
| Fulfillment | object |
| FlexPay Plan | object |
| Checkout Key | text |
| Origin Feature | text |
| Signup Transaction Reference | text |
| Enrollment Status | text |
| Next Billing Date | text |
| Plan Charges | array |
| Subscription | object |
| Status | text |
| Plan | object |
| Subscriber | object |
Watch Subscription CancellationsTrigger
| Field | Type |
|---|---|
| Date Next Charge | number |
| Product | object |
| Name | text |
| ID | number |
| Actual Recurrence Value | number |
| Subscriber | object |
| Code | text |
| Name | text |
| text | |
| Phone | object |
| Subscription | object |
| ID | number |
| Plan | object |
| Cancellation Date | number |
Watch Subscription Charge Date ChangesTrigger
| Field | Type |
|---|---|
| Subscriber | object |
| Name | text |
| text | |
| Code | text |
| Subscription | object |
| Product | object |
| Old Charge Day | number |
| New Charge Day | number |
| Date Next Charge | text |
| Status | text |
| Plan | object |
| Offer | object |
| Name | text |
| ID | number |
Get Account InfoSearch
| Field | Type |
|---|---|
Filter FieldRequired | choice |
Filter ValueRequired | text |
| Field | Type |
|---|---|
| Name | text |
| Ucode | text |
| text | |
| Entity Type | text |
| Legal Name | text |
| Mother Name | text |
| Birth Date | text |
| Country | text |
| Doc Type | text |
| Doc Value | text |
| Documents | array |
| Address City | text |
| Address Street | text |
| Address Number | text |
| Address Complement | text |
| Address State | text |
| Partners | array |
Get Event InfoSearch
Get Product OffersSearch
Get Product PlansSearch
| Field | Type |
|---|---|
ProductRequired | choice |
LimitRequired | number |
| Page Token | text |
| Field | Type |
|---|---|
| Code | text |
| Name | text |
| Description | text |
| Price | object |
| Currency Code | text |
| Value | number |
| Periodicity | text |
| Max Installments | number |
| Payment Mode | text |
| Trial Period (Days) | number |
| Subscription Recovery Enabled | boolean |
| Switch Plan Enabled | boolean |
Get Sales Price BreakdownSearch
| Field | Type |
|---|---|
LimitRequired | number |
| Page Token | text |
| Product | choice |
| Start Date | date |
| End Date | date |
| Transaction | text |
| Transaction Status | choice |
| Payment Type | choice |
| Field | Type |
|---|---|
| Transaction | text |
| Product | object |
| ID | number |
| Name | text |
| Base | object |
| Value | number |
| Currency Code | text |
| Total | object |
| Value | number |
| Currency Code | text |
| VAT | object |
| Value | number |
| Currency Code | text |
| Fee | object |
| Value | number |
| Currency Code | text |
| Coupon | object |
| Code | text |
| Value | number |
| Real Conversion Rate | number |
Get Sales SummarySearch
Get Student ProgressSearch
Get Subscriber's PurchasesSearch
Get Subscription SummarySearch
| Field | Type |
|---|---|
LimitRequired | number |
| Page Token | text |
| Product | choice |
| Subscriber Code | text |
| Accession Date From | date |
| Accession Date Until | date |
| Next Charge Date From | date |
| Field | Type |
|---|---|
| Subscriber Code | text |
| Subscription ID | number |
| Status | text |
| Lifetime (Days) | number |
| Accession Date | number |
| End Accession Date | number |
| Trial | boolean |
| Plan | object |
| Name | text |
| Recurrency Period | number |
| Product | object |
| Name | text |
| ID | number |
| Offer | object |
| Code | text |
| Last Recurrency | object |
| Number | number |
| Request Date | number |
| Status | text |
| Transaction Number | number |
| Billing Type | text |
| Unpaid Recurrencies | array |
| Subscriber | object |
| Name | text |
| ID | number |
| text |
Get Subscription TransactionsSearch
| Field | Type |
|---|---|
LimitRequired | number |
| Page Token | text |
| Product ID | number |
| Transaction | text |
| Subscriber Name | text |
| Subscriber Email | text |
| Billing Type | choice |
| Subscription Status | choice |
| Recurrency Status | choice |
| Purchase Status | text |
| Transaction Date From | date |
| Transaction Date Until | date |
| Offer Code | text |
| Purchase Payment Type | choice |
| Subscriber Code | text |
| Field | Type |
|---|---|
| Subscription ID | number |
| Last Update | number |
| Subscriber Code | text |
| Status | text |
| Billing Type | text |
| Adoption Date | number |
| Next Charge Date | number |
| Last Recurrency Start Date | number |
| Cancellation Date | number |
| Max Cycles | number |
| Last Recurrency Number | number |
| Has Unpaid Recurrency | boolean |
| Has Credit Card Change | boolean |
| Is Paid Anticipation | boolean |
| Is Paid Negotiation | boolean |
| Product | object |
| ID | number |
| Name | text |
| Trial Info | object |
| Trial | boolean |
| Trial Period | number |
| Trial End | number |
| Plan | object |
| Name | text |
| Recurrency Period | number |
| Recurrency Type | text |
| Coupon Code | text |
| Offer | object |
| Recurrency | object |
| Status | text |
| Number | number |
| Start Datetime | number |
| Payment Delays Days | number |
| Transaction Type | text |
| Number List | text |
| Transaction Sequence | number |
| Is Current Purchase | boolean |
| Has Retry | boolean |
| Scheduled Retry | number |
| Purchase | object |
| Transaction | text |
| Order Date | number |
| Approved Date | number |
| Status | text |
| Payment | object |
| Installment | object |
| Price | object |
| Commission | object |
Get User ProfileSearch
| Field | Type |
|---|---|
| ID | number |
| Name | text |
| text | |
| Login | text |
| Ucode | text |
| Phone Area Code | text |
| Phone | text |
| Profile Photo URL | url |
| Address | object |
| Street | text |
| Number | text |
| Complement | text |
| Neighborhood | text |
| City | text |
| State | text |
| Zip Code | text |
| Country | text |
| Entity Type | text |
| Locale | text |
| Commission Currency | text |
| Time Zone | text |
List Club ModulesSearch
List Club PagesSearch
List Club StudentsSearch
| Field | Type |
|---|---|
SubdomainRequired | text |
LimitRequired | number |
| Page Token | text |
| Field | Type |
|---|---|
| User ID | text |
| Name | text |
| Role | text |
| Last Access Date | number |
| First Access Date | number |
| Locale | text |
| Plus Access | text |
| Progress | object |
| Completed Percentage | number |
| Total | number |
| Completed | number |
| Status | text |
| Purchase Date | number |
| Access Count | number |
| Is Deletable | boolean |
| Class ID | text |
| Type | text |
| Engagement | text |
List CouponsSearch
List Event TicketsSearch
| Field | Type |
|---|---|
Event IDRequired | text |
LimitRequired | number |
| Buyer Email | |
| Participant Email | |
| Last Update | date |
| Lot ID | number |
| Ticket Status | choice |
| Ticket Type | choice |
| Check-in Status | choice |
| E-Ticket ID | number |
| Ticket QR Code | text |
| Page Token | text |
| Field | Type |
|---|---|
| Buyer | object |
| Ucode | text |
| Name | text |
| Participant | object |
| ID | number |
| Name | text |
| Document | text |
| Phone | number |
| E-Ticket | object |
| Ticket QR Code | text |
| Current Update | number |
| Check-in Status | text |
| Is Blocked | boolean |
| Ticket Status | text |
| Ticket Type | text |
| ID | number |
| Check-in URL | url |
| Lot | object |
| ID | number |
| Name | text |
| Product | object |
| ID | number |
| Name | text |
List Payment LinksSearch
List ProductsSearch
List SalesSearch
| Field | Type |
|---|---|
LimitRequired | number |
| Page Token | text |
| Product | choice |
| Start Date | date |
| End Date | date |
| Sales Source | text |
| Transaction | text |
| Buyer Name | text |
| Buyer Email | |
| Transaction Status | choice |
| Payment Type | choice |
| Offer Code | text |
| Commission As | choice |
| Field | Type |
|---|---|
| Product | object |
| Name | text |
| ID | number |
| Buyer | object |
| Name | text |
| Ucode | text |
| text | |
| Producer | object |
| Name | text |
| Ucode | text |
| Purchase | object |
| Transaction | text |
| Order Date | number |
| Approved Date | number |
| Status | text |
| Recurrency Number | number |
| Is Subscription | boolean |
| Commission As | text |
| Price | object |
| Payment | object |
| Tracking | object |
List Sales CommissionsSearch
List Sales ParticipantsSearch
List SubscriptionsSearch
| Field | Type |
|---|---|
LimitRequired | number |
| Page Token | text |
| Product | choice |
| Plan Names | array |
| Plan ID | number |
| Accession Date From | date |
| Accession Date Until | date |
| Status | choice |
| Subscriber Code | text |
| Subscriber Email | text |
| Transaction | text |
| Trial | boolean |
| Cancelation Date From | date |
| Cancelation Date Until | date |
| Next Charge Date From | date |
| Next Charge Date Until | date |
| Field | Type |
|---|---|
| Subscriber Code | text |
| Subscription ID | number |
| Status | text |
| Accession Date | number |
| End Accession Date | number |
| Request Date | number |
| Next Charge Date | number |
| Trial | boolean |
| Transaction | text |
| Plan | object |
| Name | text |
| ID | number |
| Recurrency Period | number |
| Max Charge Cycles | number |
| Product | object |
| ID | number |
| Name | text |
| Ucode | text |
| Price | object |
| Value | number |
| Currency Code | text |
| Subscriber | object |
| Name | text |
| text | |
| Ucode | text |
List Switchable PlansSearch
Add Shipment Tracking EventAction
| Field | Type |
|---|---|
PartnerRequired | object |
Partner IdentifierRequired | text |
TransactionRequired | text |
Tracking EventsRequired | array |
| Tracking Event | object |
| Tracking Code | text |
| Tracking URL | url |
| Carrier | text |
| Carrier Service | text |
| Shipping Type | choice |
| Estimated Delivery | date |
| Actual Delivery | date |
| Actual Freight Price | number |
| Recipient Email | |
| Is Sample | boolean |
| Order Returned On | date |
| Reason For Return | text |
Cancel SubscriptionAction
| Field | Type |
|---|---|
SubscriberRequired | choice |
Send Cancellation EmailRequired | boolean |
| Field | Type |
|---|---|
| Status | text |
| Subscriber Code | text |
| Creation Date | text |
| Current Recurrence | number |
| Date Last Recurrence | text |
| Next Charge Date | text |
| Due Day | number |
| Trial Period | number |
| Interval Type Between Charges | text |
| Interval Between Charges | number |
| Max Charge Cycles | number |
| Activation Date | text |
| Shopper | object |
| text | |
| Phone | text |
Cancel SubscriptionsAction
Change Subscription Charge DayAction
| Field | Type |
|---|---|
SubscriberRequired | choice |
Due DayRequired | number |
Charge Payment Token by OfferAction
| Field | Type |
|---|---|
Payment TokenRequired | text |
SCKRequired | text |
Offer CodeRequired | text |
Charge Payment Token by ValueAction
| Field | Type |
|---|---|
Payment TokenRequired | text |
SCKRequired | text |
ValueRequired | number |
Create CouponAction
| Field | Type |
|---|---|
ProductRequired | choice |
CodeRequired | text |
DiscountRequired | number |
| Start Date | date |
| End Date | date |
| Affiliate ID | number |
| Offer IDs | array |
Create Payment LinkAction
| Field | Type |
|---|---|
NameRequired | text |
ValueRequired | number |
CurrencyRequired | choice |
| Checkout Configuration | object |
| Offer Pix | boolean |
| Offer PayPal | boolean |
| Offer Hotmart Balance | boolean |
| Allow Hotmart to Notify Buyer | boolean |
| Bank Payment Slip Settings | object |
| Custom Thank-You Pages | object |
| Show Coupon Option | boolean |
| Request Buyer Address | boolean |
| Request Phone Number | boolean |
| Request ID Number | boolean |
| Link Configuration | object |
| Link Callback URL | url |
| Subscription | object |
| Periodicity | choice |
| Billing Configuration | object |
| Trial | object |
| Field | Type |
|---|---|
| Ucode | text |
| Name | text |
| URL | url |
Create Payment Link OfferAction
Create Payment Link PlanAction
| Field | Type |
|---|---|
Payment LinkRequired | choice |
NameRequired | text |
ValueRequired | number |
| Currency | choice |
| Periodicity | choice |
| Billing Configuration | object |
| Billing Type | choice |
| Max Number of Payments | number |
| Trial | object |
| Trial Type | choice |
| Trial Period (Days) | number |
| Field | Type |
|---|---|
| Plan Name | text |
| Plan Code | text |
| Ucode | text |
| URL | url |
Create Physical ProductAction
| Field | Type |
|---|---|
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 URL | url |
| Content Locale | text |
| Subcategory | number |
| Free Shipping | boolean |
| Status | choice |
| SKU | text |
| Cost | number |
| Image | object |
| Image ID | number |
| Image URL | url |
| Address | object |
| Postal Code | text |
| Address Number | text |
| Street | text |
| Complement | text |
| Neighborhood | text |
| City | text |
| State | text |
| Country | text |
| Additional Shipping Days | number |
| Field | Type |
|---|---|
| Ucode | text |
| SKU | text |
| Product URL | url |
Create Physical Product with Variants (V2)Action
| Field | Type |
|---|---|
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 |
| Attribute | object |
VariantsRequired | array |
| Variant | object |
PartnerRequired | object |
Partner IdentifierRequired | text |
| Partner URL | url |
| Partner Product ID | text |
| Content Locale | text |
| Subcategory | number |
| Free Shipping | boolean |
| Status | choice |
| SKU | text |
| Cost | number |
| Image | object |
| Image ID | number |
| Image URL | url |
| Address | object |
| Postal Code | text |
| Address Number | text |
| Street | text |
| Complement | text |
| Neighborhood | text |
| City | text |
| State | text |
| Country | text |
| Additional Shipping Days | number |
| Field | Type |
|---|---|
| Ucode | text |
| SKU | text |
| Product URL | url |
Delete CouponAction
| Field | Type |
|---|---|
ProductRequired | choice |
Delete Partner Credential LinkAction
| Field | Type |
|---|---|
Client IDRequired | text |
Partner IdentifierRequired | text |
Generate Bank Payment SlipAction
Generate Installment NegotiationAction
| Field | Type |
|---|---|
Subscription IDRequired | number |
RecurrencesRequired | array |
| Recurrence | number |
Payment TypeRequired | choice |
| Discount | object |
TypeRequired | choice |
ValueRequired | number |
| Document | text |
| Field | Type |
|---|---|
| Subscription ID | number |
| Transaction | text |
| Payment | object |
| Type | text |
| Expiration Date | number |
| Billet URL | url |
| Billet Barcode | text |
| Pix Code | text |
| Pix QR Code | url |
Make an API Calluniversal
Reactivate SubscriptionAction
Reactivate SubscriptionsAction
Refund SaleAction
| Field | Type |
|---|---|
TransactionRequired | text |
Register Partner Credential LinkAction
Set Physical Product Sales StatusAction
| Field | Type |
|---|---|
Product UcodeRequired | text |
PartnerRequired | object |
Partner IdentifierRequired | text |
StatusRequired | choice |
Set Product Email NotificationsAction
Switch Subscription PlanAction
Update Partner Credential LinkAction
| Field | Type |
|---|---|
Client IDRequired | text |
PartnerRequired | object |
Partner IdentifierRequired | text |
UserRequired | object |
User IdentifierRequired | text |
CredentialRequired | object |
Client IDRequired | text |
StatusRequired | choice |
| Field | Type |
|---|---|
| User | object |
| User Identifier | text |
| User Name | text |
| Credential | object |
| Client ID | text |
Update Physical ProductAction
| Field | Type |
|---|---|
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 URL | url |
| Content Locale | text |
| Subcategory | number |
| Free Shipping | boolean |
| SKU | text |
| Cost | number |
| Image | object |
| Image ID | number |
| Image URL | url |
| Address | object |
| Postal Code | text |
| Address Number | text |
| Street | text |
| Complement | text |
| Neighborhood | text |
| City | text |
| State | text |
| Country | text |
| Additional Shipping Days | number |
Update Physical Product VariantsAction
Update Physical Product WebhookAction
Update Shipment StatusAction
| Field | Type |
|---|---|
PartnerRequired | object |
Partner IdentifierRequired | text |
TransactionRequired | text |
StatusRequired | choice |
DateRequired | date |
Templates
Look for Hotmart templates in the WEXTL template library.
Browse templates →Explore alternative apps
- Salla[2]Commerce platform for products, orders, customers, and store operations.
- Lightspeed RetailConnect your retail point-of-sale system to automate inventory, sales, and customer data synchronization.
- PatreonMemberships for creators, with campaigns and patrons.
- Amazon Seller PartnerAmazon's API for selling partners to manage orders, listings, inventory, and reports.
- LoyversePoint of sale for retail stores and restaurants, with inventory.
References
- WEXTL® Hotmart Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Hotmart.
- WEXTL® visual workflow builder data.
Last updated: Sep 5, 2026 10:02