Extension Token (ZAPI Key)
The extension token, also known as ZAPI Key is an unique authentication key generated for each user who interacts with any component in the extension. This token can be used to connect your extension with a third party application through webhooks, to post messages to a channel or chat.
As an extension developer, you can allow all users of the organization to create a token, through the token generation dialog prompt.
Token generation button sample syntax
- [
- {
- "label": "",
- "type": "", // + or -
- "action":
- {
- "type": "invoke.function",
- "data":
- {
- "name": "",
- "owner": "" //Email ID of the extension developer
- },
- "confirm":
- {
- "title": "",
- "description": "",
- "input":
- {
- "type": "user_webhook_token"
-
}
- }
- }
- }
- ]
Token Generation Button Object Attributes
Action object attributes
Attribute Name | Data Type | Description |
type | string | Define the type of action a button should perform. For the token generation button, value for the type key must be invoke.function |
data | JSON Object | Define the parameters to be passed by the button of type, invoke.function |
Data object attributes
Attribute Name | Data Type | Description |
name | string | Name of the function to be invoked |
Confirm object attributes
Attribute Name | Data Type | Description |
title | string | The title of the token generation prompt |
| description | string | The description of the confirmation prompt |
input | JSON Object | Define the input type of dialog prompt |
Input object attributes
Attribute Name | Data Type | Description |
type | string | The type of input dialog prompt. Value should be:user_webhook_token |
Sample code snippet of the token generation dialog
-
response = {"text":"Click on the token generation button below!","buttons":[
- {
- "label": "Create Webhook",
- "type": "+",
- "action":
- {
- "type": "invoke.function",
- "data":
- {
- "name": "authentication"
- },
- "confirm":
- {
- "title":"Generate Webhooks for a GitLab Project",
- "description":"Connect to GitLab Projects from within Cliq",
- "input" :
-
{
- "type":"user_webhook_token"
- }
-
}
- }
- }
- ]};
- return response;
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Zoho DataPrep Resources
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
Extension Installation Handler
This handler is triggered after the installation of the extension. The main purpose of this handler is to let you (extension creator) handle certain processes, like configuring webhooks after a user installs the extension. Click Edit Code under ...Extension Incoming Webhook Handler
Integration with external applications can be done with the help of incoming webhook APIs. An extension token or ZAPI key generated by each user interacting with the extension, should be used for handling incoming webhooks and messaging apis. You ...Building a GoToMeeting Extension
The GoToMeeting extension enables users to schedule meetings, invite users, and keep track of the meetings when they have joined within Zoho CRM. With GoToMeeting you can utilize HD video conferencing and screen sharing. With this extension installed ...Extension APIs
These APIs fetch or set information related to the extension. Get extension config variable: Fetch the installation parameters of the extension. In production mode, only those parameters that have the value of the secure key set to false are ...Extension Webhook
Marketplace supports Extension Webhook , which will allow a market place app to create extension specific desk webhooks. Extension webhook access is restricted to the extension app alone so that the normal user can't make any changes on these ...
New to Zoho LandingPage?
Zoho LandingPage Resources