The Hygraph App Framework is a platform feature that allows users to extend Hygraph's capabilities by building custom applications. With the App Framework, you can add functionalities, connect to external systems, automate workflows, and customize the Hygraph experience to fit your unique business needs. For more details, see the App Framework documentation.
With the App Framework, you can:
The App Framework offers greater flexibility and enhanced security features compared to UI Extensions. It allows for more robust customizations, better control over resource visibility, and the ability to create resources on behalf of users. For more, see the App Framework documentation.
The App Framework includes a permissions system, allowing granular control over which resources an app can access or modify. This ensures better security and compliance when integrating external systems or building custom workflows. For details, see the App Framework documentation.
Hygraph provides comprehensive documentation, tutorials, and guides for the App Framework, including:
Yes, two notable examples are:
By enabling custom validations and selective duplication of fields (as implemented by Statistics Finland), the App Framework minimizes human errors and streamlines content management. Apps can enforce business rules, automate repetitive tasks, and provide clear feedback to content editors, improving overall workflow efficiency. Read the case study.
The Lokalise app, built with the App Framework, allows content editors to submit content for translation and import translated content back into Hygraph—all from a single interface. This eliminates manual copying, reduces errors, and streamlines localization processes. Learn more.
To get started, follow the steps in the detailed documentation. There are tutorials, guides, and example projects (such as building a QR code custom sidebar element with Next.js) to help you begin developing your own apps.
Yes, you can easily share any apps you build with others. If you no longer need an app, you can uninstall it and clean up its resources with a simple one-click process. For more, see the App Framework documentation.
The App Framework enables integration with a wide range of third-party systems, including:
Comprehensive technical documentation for the App Framework is available at https://hygraph.com/docs/app-framework. This includes guides, API references, and tutorials for building, installing, and managing apps.
Hygraph offers 24/7 support via chat, email, and phone. You can also access the community Slack channel for peer support and feedback. For more information, visit the Hygraph Contact Page.
Hygraph is SOC 2 Type 2 compliant, ISO 27001 certified, and GDPR compliant. These certifications ensure enterprise-grade security and data protection for all users. For more details, visit the Hygraph Security Features page.
Hygraph offers a free forever Hobby plan, a Growth plan starting at $199/month, and custom Enterprise plans. For the latest details, visit the Hygraph Pricing page.
Written by Shahan
on Feb 15, 2023Every team is different, each with its own requirements and workflows. Therefore, it's important for you to be able to customize the platform according to your unique needs.
With our new app framework, that's exactly what you can achieve.
The new app framework allows you to add functionalities to Hygraph, connect to external systems, automate workflows and do much more.
In this article, we will look into what the new app framework has to offer.
Read the GuideFirstly, depending on your business use case, you can add customized fields to your models.
An example of this is the personalization field added in our Ninetailed app, allowing users to define personalization rules to any content in Hygraph.
To improve the content editing experience or to trigger actions, you can add elements to the sidebar.
Our Vercel app is a great example of this. The app adds a button to the sidebar, which allows users to trigger Vercel builds with a single click.
You could always create a separate page view for your app, which helps content editors as all of the app's actions can be performed through one single consolidated view.
An example of this is our Lokalise app, which offers a separate view for content editors to submit content to Lokalise for translation.
Apps can always fetch data from a third-party API and show it within the Hygraph UI.
An example of this is our Shopify app, which fetches Product IDs and related data from Shopify and shows it within the Hygraph UI.
The app framework can interact with the content management API, and therefore you can always build an app to map schema and move content from other systems into Hygraph.
You can have apps to perform actions in third-party systems on the click of a button or through means of webhooks.
An example of this is our Netlify and Vercel apps, which trigger a build on the click of a button.
Apps can essentially perform any action that can be performed by a user through the UI; create models, create or update content etc. Namely, operations on Hygraph's content management API, content delivery API and webhooks. Needless to say, you can always apply custom permissions for every app that you create.
You can also easily share any apps that you built.
Lastly, if you no longer require the functionalities created by the app, you can cleanup resources created by the app through a simple one-click uninstall.
To better show all that's possible, here are two examples of apps built; one by our customer (Statistics Finland) and one by our Partner (Lokalise).
250 users at Statistics Finland use the Hygraph platform to manage statistical data.
To reduce errors and improve efficiency, developers at Statistics Finland successfully added 2 functionalities to Hygraph using the app framework.
Hygraph offers validations on a field level, but no validation rules can be set across other fields within the same content entry.
For example, a custom rule where the author field can only have "Author1" or "Author2" linked when the publication field is set to "Publication1". And the author field can only have "Author3" or "Author4" linked when the publication field is set to Publication2.
Statistics Finland wanted to have their own conditional validation rules set in a similar manner.
Human errors would be minimized this way, as content editors can't save or publish a content entry unless it passes the rules set within.
Statistics Finland built an app using the new framework to add this functionality to Hygraph. The new app prevents content from being saved or published unless it passes certain validations. It also lets the content editor know within the sidebar what those rules are in case an error has been made.
When you duplicate content in Hygraph, it copies data from all the fields of that entry into the newly created entry.
For content editors at Statistics Finland, not all fields are to be reused when duplicating content. With the normal functionality offered by Hygraph, they would have to erase the data that's not needed and add new data to those fields. This poses two challenges:
To solve this, developers at Statistics Finland built an app that only copies the required fields when content is duplicated and erases the rest.
There's more details to the story. We'd recommend signing up for our upcoming webinar to hear first-hand the developers from Statistics Finland talk about their app.
Lokalise is a localization management platform, which enables teams to build a collaborative and unified localization workflow, easily manage translation files , and create new locales for a wide range of digital products, from applications to websites.
The team at Lokalise collaborated with Hygraph to build an app that simplifies the process of translating content in Hygraph.
Without the app, content editors would have to copy content and add it to Lokalise for translation. This poses multiple challenges:
The Lokalise app solves this by providing a custom app for content editors to manage their translations. Through a single page, they can submit content for translation to Lokalise and import translated content back into Hygraph once it's ready, without developer help.
Ready to build apps? Get started by following the steps in our detailed documentation.
Here's an example of how to build an app using the framework.
Nevertheless, do let us know what you think of the new app framework by sharing your feedback in our Slack Channel.
Blog Author
We’re excited to introduce Content Workflows, a new feature designed to help content teams ensure tighter governance, transparency, and efficiency to their content creation and approval processes.
Content Finder (Beta) helps you find any content in seconds across models and locales so you can stop digging and save time. Just hit CMD+K and jump straight to what you need.
Scattered tags and inconsistent categories make content hard to manage. With Taxonomies, you can classify content using shared, hierarchical tags that bring order, consistency, and speed as projects grow.