Build and test your app
Build and test your app
Use your sponsored Zendesk Support account to build and test your app. If you haven't built an app yet and would like advice, see the resources below.
General resources
For questions and answers, see the Zendesk Apps framework (ZAF) community.
You can also join the Zendesk Platform Developer Slack channel.
Apps resources
-
Demo Apps Github repo - Example apps that demonstrate the features and capabilities of the Apps framework. You can use parts of the code in your own app.
-
Build your first Support app - A step-by-step guide to creating an app.
-
Building a server-side app - A step-by-step guide to creating a Zendesk app that is served from your own infrastructure.
-
Design Guidelines - A resource for building a consistent app experience using Garden, Zendesk's design system.
REST API resources
If you plan on using any of the Zendesk REST APIs, see the following resources:
-
Rate limiting - Your integration may not be the only one customers use. So it is good practice to minimize the number of API calls to avoid rate limiting.
-
Incremental Exports and side-loading - If you're building anything that requires a lot of ticket data, consider using the Incremental Exports API, as well as side-loading resources.
-
Security and Authentication - A few authentication options are available, but Zendesk highly recommends using OAuth2.
- If you're not familiar with OAuth, see Using OAuth authentication with your application and Adding third-party OAuth to a Support app.
- If you need a global OAuth client, see Set up a global OAuth client.
-
If you plan on making requests to the Zendesk REST API from an external service instead of the Apps framework, see Request header requirements for Marketplace apps.
Next steps: Set up a global OAuth client