Recent searches
No recent searches
Not able to access parameters (defined in manifest.json) from Zendesk Admin center..
Answered
Posted Aug 30, 2023
Hello
We have created parameters in "manifest.json" to get certain inputs from "Zendesk Admin Center" (Let say, API key and API token)..
We used, "client.metadata" in code, to get those parameters in our app..
It is working fine, when running locally..
Now, Our app is launched in Zendesk Marketplace (in preview state).. Here, we cant able to capture that parameter values..
The fields are getting populated in the Zendesk Admin center, as shown below..
The user will enter the API key and API token, during installation.. But, we are not sure these values are getting stored in the Admin center..
Looking forward for solution on this issue..
Thank you..
0
6
6 comments
Eric
Hey there!
Are these values using the secure flag? If so once set they won't be visible to the UI/ Are they set to required? If not I'd recommend doing this so that users can't move past the installation without filling them out.
0
Abdul Hameed P
Hii Eric
Thanks for your response.. :)
Below are the parameters we mentioned in Manifest.json.. And we added "secure" and "required" field for these parameters..

But, these values (API key and API token) are not able to capture in our app..
One thing, These values are not marked as 'required (*)' during installation, as shown below..
So, May that will be reason for not capturing those values in our app?..
Looking forward for solutions..
Thanks
0
Abdul Hameed P
Hii Eric
Thanks for your response.. :)
Below are the parameters we mentioned in Manifest.json.. And we added "secure" and "required" field for these parameters..
But, these values (API key and API token) are not able to capture in our app..
One thing, These values are not marked as 'required (*)' during installation, as shown below..
So, May that will be reason for not capturing those values in our app?..
Looking forward for solutions..
Thanks
0
Chris Sos
Hi Abdul Hameed P,
Secure settings can not be accessed from the app or displayed in the browser console for security reasons. Only the placeholder should be included, which is replaced with the secret as the request goes outside of Zendesk to the server. Check out secure settings on the docs to learn more.
Please also note, settings once entered into the app during installation are not shown again. Rest assured the settings have been captured. Though if they are required fields for your app to work properly, I'd recommend marking them as required so that users can not complete installation without populating them.
Hope this helps.
Chris
1
Abdul Hameed P
Hi @...
Thanks for your response.. :)
I'm using "client.metadata" to retrieve the "secure" parameters (like API key and API token) in our app.. But, I'm unable to capture that parameter values...
So, can you please suggest, is there any "API call" to access "secure" parameters inside our app from ZENDESK ADMIN CENTER..
Looking forward for solutions..
Thank you..
0
Chris Sos
Hi Abdul Hameed P,
By design, these credentials are not accessible to apps via the API. This is for security reasons. Because apps run in the browser context, this would expose credentials to agents which could compromise systems.
The use case for secure parameters is to decorate a request as it leaves Zendesk, ensuring the credentials remain secure and are not leaked to agents.
I'd look at re-evaluating the need to retrieve the credentials within the app flow, or think about server-side authentication so that your service remains secure.
Hope this helps!
Chris
0