Incomaker Commons v4
API Reference
API Reference
  1. Website Widget
  • Incomaker Commons v4
  • Sklik audience response validation
  • Social Accounts
    • Get Accounts
  • Ad Accounts
    • Get Accounts for Facebook
  • Assets
    • Generate e-mail content (AI)
  • Audiences
    • Get Audiences
  • Campaigns
    • Get campaigns
    • Archive Campaign
    • Pause/Resume/Cancel Campaign
    • Rename Campaign
    • Duplicate Campaign
    • Delete Campaign
    • Get Categories
    • Add New Category
  • Contacts
    • Get contact by clientContactId
    • Get contact by email
    • Add contact to the list by id
    • Remove contact from the list by id
    • Add contact to the list by name
    • Remove contact from the list by name
    • Get contact by phoneNumber1
    • Upsert multiple contacts (async)
    • Get contact events
    • Get contact events by client id
    • Get contact events by email
    • Partially update contact
    • Get all contacts
    • Create contact
    • Upsert contact
    • Get contact
    • Update contact
    • Delete contact
    • Get total number of contacts
    • Upsert multiple contacts
    • Delete multiple contacts
    • Contact login
    • Contact logout
    • Get contact`s subscriptions
    • Replace contact's subscriptions (full set)
    • Adjust contact's subscriptions (partial)
    • Unsubscribe a contact from all lists
  • Carts
    • Add an Item to Cart
    • Remove an Item from Cart
    • Create an Order from Cart (checkout)
  • Deals
    • Get deal
    • Update deal
    • Delete deal
    • Find deals
    • Create deal
    • Get deals attachments
    • Post deals attachment
    • Delete deals attachment
    • Get deals contacts
    • Add deals contacts
    • Remove contact from deal
    • Get deals activities
    • List deal states
    • Create deal state
    • Update deal state
    • Delete deal state
  • Delivery
    • Send E-mails delivery
    • Send SMS delivery
    • Send push delivery
    • Send Test E-mail
    • Send Test SMS
    • Send Test Push
    • Validate E-mail (dry run)
    • Validate SMS (dry run)
    • Validate Push (dry run)
    • Get Delivery Job
    • List Delivery Jobs
    • Cancel Delivery Job
    • Pause Delivery Job
  • Events
    • Add event with contact
    • Add tracking event
    • Get event types
  • Forms
    • Get form settings
    • Update form settings
    • Get form field mappings
    • Update form field mappings
  • Notifications
    • Get notifications
    • Get notification
    • Modify notification
    • Delete notification
  • Lists
    • Get Lists
    • Create List
    • Get List
    • Update List
    • Delete List
    • Get List by name
    • Update List by name
    • Delete List by name
    • Get number of contacts for a list
    • Get number of contacts for a list by name
    • Get contact counts for all lists (grouped by category)
    • Upsert Lists (bulk)
    • Get List categories
    • Create List category
    • Get List category
    • Update List category
    • Delete List category
    • Get List category by name
    • Update List category by name
    • Delete List category by name
    • Upsert List categories (bulk)
  • Products
    • Get total number of products
    • Delete multiple products
    • Get variant
    • Get products
    • Get products categories
    • Get tags
    • Create product
    • Upsert product
    • Upsert multiple products (sync)
    • Upsert multiple products (async job)
    • Get product
    • Replace product
    • Partially update product
    • Delete (deactivate) product
    • Upsert single variant
    • Partially update variant
    • Delete (deactivate) variant
    • Add tag to product
    • Remove tag from product
    • Add product to category
    • Remove product from category
    • Create product category
    • Upsert product category
    • Upsert multiple product categories
    • Get product category
    • Replace product category
    • Partially update product category
    • Delete (hide) product category
  • Orders
    • Get orders
    • Create order
    • Upsert multiple orders
    • Get order
    • Update order
    • Update order state
    • Delete order
    • Get order by client ID
    • Update order by client ID
    • Update order state by client ID
    • Delete order by client ID
  • Scenarios
    • Abandoned cart notification by e-mail
    • Abandoned cart notification by SMS
    • Abandoned cart notification by push
    • Abandoned cart notification by Facebook
    • Create birthday greetings
    • Create nameday greetings
    • Create first purchase anniversary
  • Smartflows
    • Triggers
      • Start
        • Get Start trigger
        • Delete Start trigger
        • Create Start trigger
      • Added to list
      • Removed from list
      • Scheduled start
        • Get Scheduled start trigger
        • Update Scheduled start trigger
        • Delete Scheduled start trigger
        • Create Scheduled start trigger
      • Recurring
        • Get Recurring trigger
        • Update Recurring trigger
        • Delete Recurring trigger
        • Create Recurring trigger
      • Nameday
        • Get Nameday trigger
        • Update Nameday trigger
        • Delete Nameday trigger
        • Create Nameday trigger
      • Birthday
        • Get Birthday trigger
        • Update Birthday trigger
        • Delete Birthday trigger
        • Create Birthday trigger
      • First registration
        • Get First registration trigger
        • Update First registration trigger
        • Delete First registration trigger
        • Create First registration trigger
      • First purchase
        • Get First purchase trigger
        • Update First purchase trigger
        • Delete First purchase trigger
        • Create First purchase trigger
      • Email subscription confirmed
        • Get Email subscription confirmed trigger
        • Update Email subscription confirmed trigger
        • Delete Email subscription confirmed trigger
        • Create Email subscription confirmed trigger
      • Link click
        • Get Link click trigger
        • Update Link click trigger
        • Delete Link click trigger
        • Create Link click trigger
      • Mail open
        • Get Open mail trigger
        • Update Open mail trigger
        • Delete Open mail trigger
        • Create Open mail trigger
      • Product added to cart
        • Get Product added to cart trigger
        • Update Product added to cart trigger
        • Delete Product added to cart trigger
        • Create Product added to cart trigger
      • Custom event
        • Get Custom event trigger
        • Update Custom event trigger
        • Delete Custom event trigger
        • Create Custom event trigger
      • Abandoned cart
        • Get Abandoned cart trigger
        • Update Abandoned cart trigger
        • Delete Abandoned cart trigger
        • Create Abandoned cart trigger
    • Actions
      • Sklik Audience
        • Get Sklik audience action
        • Update Sklik audience action
        • Delete Sklik audience action
        • Create Sklik audience action
        • Connect Sklik account
        • Disconnect Sklik account
        • Get Sklik audiences for action
        • Create Sklik audience
      • Meta audience
        • Create Meta audience
        • Get Meta audience action
        • Update Meta audience action
        • Delete Meta audience action
        • Create Meta audience action
        • Get Meta audiences for action
        • Connect Meta Account
        • Disconnect Meta account
        • Get list of business portfolios
        • Get list of advertising accounts
      • GoogleAds Audience
        • Create GoogleAds audience
        • Get GoogleAds audience action
        • Update GoogleAds audience action
        • Delete GoogleAds audience action
        • Create GoogleAds audience action
        • Get GoogleAds audiences for action
        • Connect GoogleAds Account
        • Disconnect GoogleAds account
        • Get list of users
      • Double Opt-In
        • Get Double Opt-In action
        • Update Double Opt-In action
        • Delete Double Opt-In action
        • Create Double Opt-In action
        • Swap branches
      • Add contact to list
        • Get Add contact to list action
        • Update Add contact to list action
        • Delete Add contact to list action
        • Create Add contact to list action
      • Remove contact from list
        • Get Remove contact from list action
        • Update Remove contact from list action
        • Delete Remove contact from list action
        • Create Remove contact from list action
      • Teaser
        • Get Teaer action
        • Create Teaer action
        • Delete Teaer action
      • Add tag to contact
        • Get Add tag action
        • Update Add tag action
        • Delete Add tag action
        • Create Add tag action
      • Remove tag from contact
        • Get Remove tag action
        • Update Remove tag action
        • Delete Remove tag action
        • Create Remove tag action
      • Notification
        • Get Send notification
      • Website Widget
        • Get Website Widget action
          GET
        • Create Website Widget action
          POST
        • Update Website Widget action
          PUT
        • Delete Website Widget action
          DELETE
    • Targets
    • Activities
      • Convert activity
      • Duplicate activity
      • Enable/Disable activity
      • Update activity shared fields
    • Structure
      • Get smartflow structure
      • Delete a part of smartflow
    • Get Added to contact list trigger
      GET
    • Get smartflows
      GET
    • Update Added to contact list trigger
      PUT
    • Create smartflow
      POST
    • Delete Added to contact list trigger
      DELETE
    • Get smartflow
      GET
    • Create Added to contact list trigger
      POST
    • Update smartflow
      PATCH
    • Get Removed from contact list trigger
      GET
    • Delete smartflow
      DELETE
    • Update Remove from contact list trigger
      PUT
    • Delete Remove from contact list trigger
      DELETE
    • Generate smartflow (AI)
      POST
    • Create Removed from contact list trigger
      POST
    • Pause/Resume/Cancel smartflow
      POST
    • Execute smartflow
      POST
    • Validate smartflow
      GET
    • Export smartflow
      POST
    • Import smartflow
      POST
    • Duplicate smartflow
      POST
    • Get smartflow actions
      GET
    • Archive smartflow
      POST
    • Get templates
      GET
    • Create template
      POST
    • Get template actions
      GET
    • Get folders
      GET
    • Create folder
      POST
    • Modify folder
      PATCH
    • Delete folder
      DELETE
    • Get Product in Cart is back in Stock trigger
      GET
    • Update Product in cart is back in stock trigger
      PUT
    • Delete Product in cart is back in stock trigger
      DELETE
    • Create Product in cart is back in stock trigger
      POST
    • Get Product in Cart discounted trigger
      GET
    • Update Product in Cart discounted trigger
      PUT
    • Delete Product in Cart discounted trigger
      DELETE
    • Create Product in Cart discounted trigger
      POST
    • Get Product in cart running out trigger
      GET
    • Update Product in cart running out trigger
      PUT
    • Delete Product in cart running out trigger
      DELETE
    • Create Product in cart running out trigger
      POST
    • Get Product purchased trigger
      GET
    • Update Product purchased trigger
      PUT
    • Delete Product purchased trigger
      DELETE
    • Create Product purchased trigger
      POST
    • Get Recently purchased trigger
      GET
    • Update Recently purchased trigger
      PUT
    • Delete Recently purchased trigger
      DELETE
    • Create Recently purchased trigger
      POST
    • Get Checkout visited trigger
      GET
    • Update Checkout visited trigger
      PUT
    • Delete Checkout visited trigger
      DELETE
    • Create Checkout visited trigger
      POST
    • Get Order cancelled trigger
      GET
    • Delete Order cancelled trigger
      DELETE
    • Create Order cancelled trigger
      POST
    • Get Invoice confirmation trigger
      GET
    • Delete Invoice confirmation trigger
      DELETE
    • Create Invoice confirmation trigger
      POST
    • Get Return confirmation trigger
      GET
    • Delete Return confirmation trigger
      DELETE
    • Create Return confirmation trigger
      POST
    • Get Website search trigger
      GET
    • Update Website search trigger
      PUT
    • Delete Website search trigger
      DELETE
    • Create Website search trigger
      POST
    • Get Campaign sent trigger
      GET
    • Update Campaign sent trigger
      PUT
    • Delete Campaign sent trigger
      DELETE
    • Create Campaign sent trigger
      POST
    • Get Shipping confirmed trigger
      GET
    • Update Shipping confirmed trigger
      PUT
    • Delete Shipping confirmed trigger
      DELETE
    • Create Shipping confirmed trigger
      POST
    • Get Website Viewed trigger
      GET
    • Update Website Viewed trigger
      PUT
    • Delete Website Viewed trigger
      DELETE
    • Create Website Viewed trigger
      POST
    • Get Filter target
      GET
    • Update Filter target
      PUT
    • Delete Filter target
      DELETE
    • Create Filter target
      POST
    • Get Merge target
      GET
    • Delete Merge target
      DELETE
    • Create Merge target
      POST
    • Get Split target
      GET
    • Update Split target
      PUT
    • Delete Split target
      DELETE
    • Create Split target
      POST
    • Get Splitter target
      GET
    • Update Splitter target
      PUT
    • Delete Splitter target
      DELETE
    • Create Splitter target
      POST
    • Get Condition target
      GET
    • Update Condition target
      PUT
    • Delete Condition target
      DELETE
    • Create Condition target
      POST
    • Get A/B test action
      GET
    • Update A/B test action
      PUT
    • Delete AB test target
      DELETE
    • Create AB test target
      POST
    • Get Send mail action
      GET
    • Update Send email action
      PUT
    • Delete Send mail action
      DELETE
    • Create Send mail action
      POST
    • Get Send sms action
      GET
    • Update Send sms action
      PUT
    • Delete Send sms action
      DELETE
    • Create Send sms action
      POST
    • Get Send social post action
      GET
    • Update Send social post action
      PUT
    • Delete Send social post action
      DELETE
    • Create Send social post action
      POST
    • Get Send NPS action
      GET
    • Update Send NPS action
      PUT
    • Delete Send NPS action
      DELETE
    • Create Send NPS action
      POST
    • Get Webhook action
      GET
    • Update Webhook action
      PUT
    • Delete Webhook action
      DELETE
    • Create Webhook action
      POST
    • Get Delay action
      GET
    • Update Delay action
      PUT
    • Delete Delay action
      DELETE
    • Create Delay action
      POST
    • Get Landing page action
      GET
    • Update Landing page action
      PUT
    • Delete Landing page action
      DELETE
    • Create Landing page action
      POST
    • Get Unsubscribe action
      GET
    • Update Unsubscribe action
      PUT
    • Delete Unsubscribe action
      DELETE
    • Create Unsubscribe action
      POST
    • Get list of contact fields to update
      GET
    • Get Update contact action
      GET
    • Update Update contact action
      PUT
    • Delete Update contact action
      DELETE
    • Create Update contact action
      POST
    • Get Popup action
      GET
    • Update Popup action
      PUT
    • Delete Popup action
      DELETE
    • Create Popup action
      POST
  • Website
    • Get Website Info
    • Get Teaser settings
  • Tags
    • Get Tags
    • Create Tag
    • Update Tag
    • Get Tag
    • Delete Tag
    • Get number of contacts for a tag
    • Get contact counts for all tags (grouped by category)
    • Create Tags (bulk)
    • Get Tag categories
    • Create Tag category
    • Get Tag category
    • Update Tag category
    • Delete Tag category
    • Create Tag categories (bulk)
  • Context
    • Get Context
    • Update Context
    • Replace Context
  • Admin
    • Refresh Currency Rates
  • Jobs
    • Get job status
    • List jobs
    • List job items
    • Cancel job
  • SMS
    • Get SMS Templates
    • Get SMS Templates History
    • Create SMS Template
    • Get SMS Senders
  • Coupons
    • Get Coupons
    • Get Coupons types
    • Get Coupon type
  • Tracking Links
    • Create Tracking Link
  • Webhooks
    • Webhooks — Usage Guide
    • List webhook topics
    • Create webhook
    • List webhooks
    • Get webhook
    • Update webhook
    • Delete webhook
    • Test-send webhook
    • List deliveries for a webhook
    • Get delivery detail
  • Messages
    • Send e-mail
    • Send e-mails (batch)
    • Validate e-mail (dry run)
    • Send SMS
    • Send SMS (batch)
    • Validate SMS (dry run)
    • List messages
    • Get message
    • Cancel scheduled message
    • Send e-mails (batch, async)
    • Send SMS (batch, async)
    • Send e-mail to an audience
    • Send SMS to an audience
  • Billing
    • Create billing settings
    • Update billing settings
    • Get billing settings
  • List domains
    GET
  • Add domain
    POST
  • Get DNS records
    GET
  • Get link shorteners
    GET
  • Update link shorteners
    PUT
  • Verify DNS changes
    POST
  • Get eshop settings
    GET
  • Update eshop settings
    PUT
  • Get Smartflow Validation Rules
    GET
  • Get invoices
    GET
  • Get invoices
    GET
  • Get custom contact field placeholders
    GET
  • Get contact placeholders
    GET
  • Get system placeholders
    GET
  • Get account placeholders
    GET
  • Get user placeholders
    GET
  • Get external placeholders
    GET
  • Get coupon placeholders
    GET
  • Get media
    GET
  • Upload media
    POST
  • Get media item
    GET
  • Update media metadata
    PUT
  • Delete media
    DELETE
  • Get media tags
    GET
  • Schemas
    • Audience
    • Notification
    • Error
    • CampaignType
    • Contact
    • Product (read)
    • ProductWriteNoId
    • Product tag
    • ProductCategoryWriteNoId
    • Price
    • CampaignChannel
    • CampaignState
    • Campaign
    • CustomField
    • Context
    • ProductLanguage
    • ProductVariantWriteNoId
    • CreateActionResponse
    • ProductVariantWrite
    • TeaserFontFamily
    • TeaserFontWeight
    • ProductWrite
    • TeaserCloseButtonSize
    • TeaserCloseButtonPosition
    • ProductVariant
    • TeaserPosition
    • NotificationSeverity
    • CategoryLanguage
    • NotificationChannel
    • Tag
    • ProductCategoryWrite
    • TagCategory
    • ProductCategory
    • List
    • UpsertResult
    • ListCategory
    • VariantUpsertResult
    • CategoryUpsertResult
    • SmartflowTemplateAction
    • BulkResult
    • SmartflowAction
    • CategoryBulkResult
    • SmartflowState
    • SmartflowCompletedState
    • SocialNetworkType
    • SocialNetworkEntityType
    • SocialNetworkEntity
    • SocialNetworkUser
    • Smartflow
    • SmartflowFolder
    • SocialAccount
    • AudienceInput
    • EmailAsset
    • SmsAsset
    • PushAsset
    • Cron
    • SocialAccountsResponse
    • AdAccount
    • AdAccountsResponse
    • AudiencesResponse
    • ProductsResponse
    • ProductsCategoriesResponse
    • ProductTagsResponse
    • SmartflowsResponse
    • SmartflowFoldersResponse
    • SmartflowActionsResponse
    • SmartflowTemplateActionsResponse
    • Paging
    • TeaserSettings
    • WebsiteSettings
    • General rules
    • PermId
    • Events
    • CouponType
    • Coupon
    • Media item
  1. Website Widget

Create Website Widget action

POST
/smartflows/{smartflowId}/actions/website-widget
Launches a website widget based on the store's data - personalized product recommendations (similar products, cross-sell, up-sell) shown to the right customer in real-time. Content is managed entirely through the widget editor iframe, not through this node's own fields.

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200Success
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/smartflows//actions/website-widget' \
--header 'Authorization: Bearer JWT' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Custom activity name",
    "ancestorId": "4a06896c-81b3-44f4-b493-2057bef951a2",
    "cssSelector": ".product-recommendations",
    "modifyType": "append"
}'
Response Response Example
{
    "activityId": "string",
    "name": "string",
    "campaignUuid": "string",
    "nextActivityType": "triggers"
}
Modified at 2026-09-23 12:57:08
Previous
Get Website Widget action
Next
Update Website Widget action
Built with