Recent searches


No recent searches

App's parameter

Answered


Posted Jan 26, 2023

Hi,

is it possible to have the admin save a parameter in our custom app?
In my use case, I make calls to external APIs and I would like the user of my app to enter their own API keys that is to be used in my app.

Thanks!


0

7

7 comments

image avatar

Christopher Stock

Zendesk LuminaryCommunity Moderator

Hey Alexis Davidson. You can do this by adding a 'parameters' array to your apps manifest.json file. There's more information about it here.

 

2


Thank you Christopher Stock that's what I needed! I'm sorry I'm having a difficult time finding the what I need in the docs even after researching online as well.

Apparently when testing locally, I can set these parameters when I launch the dist server. Where would an admin set these settings on the real online environment?

0


image avatar

Christopher Stock

Zendesk LuminaryCommunity Moderator

Great, glad I could help. The admin installing the app will be presented with the app configuration screen as part of the installation process. This screen can also be accessed at any time in the future by accessing the 'Change settings' menu for an installed app.

There are native configuration options that appear for all apps (Title, Role restrictions, Group restrictions) plus any specific parameters for the app.

Admins can find this in the Admin Centre > Apps and Integrations > Apps > Zendesk Support apps

1


An app parameter is a container for values that are used repeatedly in your application. You can insert an app parameter into a DataPage, authentication, or connection object. It can be edited independently without editing the object where the app parameter is used.

0


  1. On the App Parameters screen, click Create app parameter. A new row is added to the list of parameters.
  2. Enter the following information in the appropriate fields: Parameter Name – enter a unique identifier for the parameter. ...
  3. Click Save. You can now use this parameter in your application.

0


Hi Team, https://support.zendesk.com/hc/en-us/profiles/1263169173630-Christopher-Stock,

What are the param type we can use? Can we use multi-line or Text area param type in manifest.json file? it is throwing error stating invalid param.

0


image avatar

Tipene Hughes

Zendesk Developer Advocacy

Hi Keerthanapriya,

Here's a link to the docs which describe the available types in the manifest parameters. In your case, you should use the type "multiline".

0


Please sign in to leave a comment.

Didn't find what you're looking for?

New post