How to Create a Marketplace Application?

How to Create a Marketplace Application?

Creating a Marketplace App in Kylas allows developers and businesses to integrate external applications with the CRM seamlessly. Whether you're building a private integration or a public-facing utility for all Kylas users, this guide will walk you through the complete process — from app creation to OAuth setup.


Prerequisites

Before you start creating an app on Kylas Marketplace, ensure the following:

  • You have a Kylas Developer Account with necessary permissions.

  • You have access to a hosted application or web interface that your app will link to.

  • You understand OAuth 2.0 authorization (as it is required for app installation and communication).

  • You have your app backend ready to receive parameters and handle token exchange.


Table of Contents

  1. Introduction to Marketplace App in Kylas

  2. Step-by-Step Guide to Create a Marketplace App

  3. Setting Up OAuth Authorization

  4. Example Request & Response Format

  5. Use Cases

  6. Benefits

  7. Conclusion


Step-by-Step Guide to Create a Marketplace App

Step 1: Initiate App Creation

  • Navigate to Kylas Marketplace > Manage Apps > Create App.

  • Fill in the required details:

    • App Type: Choose Private or Public.

    • App Category: Select the appropriate category.

    • Name & Summary: Provide the app name and a short summary.

    • Callback URL: The redirect URI where the authorization code will be sent.

    • Website URL: URL where your app is hosted (used for iframe loading).

    • App Description: Describe your app’s features and use case.

    • Click Next.

.




Step 2: App Icon and Help Section

  • Upload an App Icon (visible on the Marketplace).

  • Add a Help Section or Link explaining how to use the app.

Click Next.

 



Step 3: Permissions

  • Define what permissions your app requires. These will be shown during installation.

    • Example:

      • Call >> Create

      • Lead >> Call

      • Contact >> Call

Click Next.



Step 4: App Actions

  • Decide if the app will perform actions within Kylas (Yes/No).

  • Choose between:

    • Basic Actions – opens app in new tab.

    • Embedded Actions – opens app inside an iframe in Kylas.

  • Define:

    • Action Name (e.g., Click to Call).

    • Target URL (which will receive Kylas parameters as query params).

  • Choose the location (e.g., Lead Details Page, More Actions menu).

  • You can add multiple actions by clicking "Add New".

Click Next.



Step 5: App Triggers and OAuth Setup

  • Add triggers to link the app with Kylas Workflows.

  • You will now receive:

    • Client ID

    • Client Secret

  • These will be used for generating access tokens and setting up authorization.

To publish publicly, share the App ID and configurations with the Kylas team.



·
 If I select lead details page – inside more action , then you will receive lead ID, where app can call search lead by API by ID to get all the lead information
o https://integrations.kylas.io/payment_link_logs/new?tenantName=Amura+Marketing+Technologies&tenantId=XXXX&userName=Tushar+Pingate&userId=6XXX&entityId=3528133&entityType=leads&actionName=Generate+Payment+Link&location=DETAILS_PAGE&userPhoneNumber=918888556524&entityName=demo+Lead


 

 



OAuth Setup: Authorizing Your App

Once the app is ready and installed, OAuth 2.0 authorization begins:

Step 1: Kylas Sends Auth Code

Redirected to your registered Redirect URI in the format:

<Redirect URL>?code=auth_code

Step 2: Exchange Auth Code for Tokens

Use a POST request to exchange auth code:

curl --location --request POST 'https://api.kylas.io/oauth/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic <base64(client_id:client_secret)>' \
--data-urlencode 'grant_type=authorization_code' \
--data-urlencode 'code=<auth_code>' \
--data-urlencode 'redirect_uri=<Redirect URL>'


Step 3: Receive Access & Refresh Tokens

Sample Response:

{
  "access_token": "access-token",
  "token_type": "bearer",
  "refresh_token": "refresh-token",
  "expires_in": 86399,
  "scope": "lead:read pipeline:read"
}

  • expires_in: Token validity in seconds.

  • Refresh token is valid for 90 days.


Step 4: Use Refresh Token to Get New Access Token

curl --location --request POST 'https://api.kylas.io/oauth/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic <base64(client_id:client_secret)>' \
--data-urlencode 'grant_type=refresh_token' \
--data-urlencode 'refresh_token=<refresh_token>'

Marketplace OAuth Document

 
  



 Use Cases:

Use Case
Description
Click-to-Call Integration
Call leads/contacts directly from Kylas using your app.
WhatsApp Messaging Tool
Send WhatsApp messages from Kylas interface.
Payment Link Generator
Trigger payment link from Deal/Lead detail page.
SMS/Email Campaign Integration
Send campaigns based on Kylas filters.
Custom Quotation Builder
Build dynamic quotations through an external interface.
Order Management Dashboard
Sync CRM leads with external order systems.
Smart Reporting Tool
Show custom dashboards/reports via embedded action.
Feedback Collection App
Collect survey/feedback post-deal closure.


Conclusion

Building a Kylas Marketplace App empowers developers to extend CRM capabilities, automate business workflows, and deliver a seamless user experience. Whether you're enhancing internal operations or building a tool for all users, the app creation process in Kylas is designed to be developer-friendly, secure, and scalable.

With proper planning, OAuth implementation, and action triggers, your app can become a powerful part of the Kylas ecosystem.


 




    • Related Articles

    • How to uninstall a marketplace application?

      This article covers the steps to be followed for uninstalling marketplace applications with a KYLAS CRM account.  Prerequisites Permissions: Any user who has a marketplace app installed Product Plans: Elevate, Explore Activities to be ...

    • How to Install SMS application?

      This article covers the steps to be followed and the pre-requisites for installing SMS App. How to Install SMS App Prerequisites Permissions: Any user having access to Kylas marketplace. Product Plans: Elevate. Step 1: Login to kylas using your ...

    • What are triggers in marketplace app and how to add triggers?

      This article covers the steps to take for adding triggers in marketplace application. What are triggers? Triggers in marketplace apps enables the app developers to trigger Kylas workflows based on an event that takes place in their application. And ...

    • How to add workflow actions in a Kylas marketplace app to perform automated actions?

      This article covers the steps to enable Workflow actions in a marketplace app actions at the time of app creation so that the users of your marketplace application can use the actions to perform some marketplace actions automatically via Kylas ...

    • How to add marketplace app trigger as a trigger event for Kylas workflow?

      This article covers the steps to perform in order to add a marketplace app trigger as the workflow trigger event. This will enable you to let a workflow get triggered by an external event taking place in a marketplace app and you can use this for ...