Frequently Asked Questions

App Registration & Getting Started

How do I register a new app in the Hygraph App Framework?

To register a new app in Hygraph, navigate to Your apps in your project directory or user settings and click the + Add new app button. This will open the App registration form. Fill out the required fields in the General, Permissions, and Elements tabs. For a detailed walkthrough, see the Register an app documentation.

What information is required in the General tab when registering an app?

In the General tab, you need to provide the following details:

How do I set permissions for my app, and what should I consider?

Permissions are set during the app registration process in the Permissions tab. You can choose between read, write, or both. For tutorials, read/write permissions are suggested, but you can select your own. Note: Permissions cannot be edited after the initial save, so review your choices carefully. For details on each permission, refer to the permissions documentation.

What types of elements can I add to my app during registration?

You can add three types of elements:

Each element requires a name, API ID, type, URL, and description. For step-by-step instructions, see the Register your app guide.

Where can I find resources and documentation for developing apps with Hygraph?

Hygraph provides extensive documentation and resources for app development, including:

Features & Capabilities

What are the key capabilities of the Hygraph App Framework?

The Hygraph App Framework enables developers to create custom apps that extend Hygraph's core functionality. Key capabilities include:

For more, see the App Framework Overview.

Does Hygraph provide performance, security, and compliance features for app development?

Yes, Hygraph offers robust performance, security, and compliance features:

Support & Implementation

What support and resources are available for developers building apps with Hygraph?

Hygraph provides multiple support channels:

How easy is it to get started with app development on Hygraph?

Getting started is straightforward:

For example, Top Villas launched a new project within 2 months, and Si Vale met aggressive deadlines during implementation (Top Villas case study).

Use Cases & Benefits

Who can benefit from building apps with the Hygraph App Framework?

The App Framework is ideal for:

Hygraph helps modernize legacy tech stacks and scale digital experiences (source).

What problems does the Hygraph App Framework solve for businesses?

Hygraph addresses operational inefficiencies (reducing developer dependency, streamlining workflows), financial challenges (lowering costs, accelerating speed-to-market), and technical issues (simplifying schema evolution, improving integration, optimizing performance, and enhancing localization/asset management). These solutions help businesses modernize their content management and deliver exceptional digital experiences (source).

Technical Requirements & Best Practices

What are the steps after registering my app in Hygraph?

After registering your app, the next steps are:

Each step is documented in the First Steps tutorial.

Can I edit my app's permissions or API ID after registration?

No, permissions and API ID cannot be edited after the initial save. Ensure you review and confirm these details before registering your app (source).

What documentation is available for each stage of app development in Hygraph?

Hygraph provides stage-specific documentation for app development:

Help teams manage content creation and approval in a clear and structured way
Hygraph
Docs
You are currently reading the Studio Docs. If you were looking for the Classic Docs check here

#Register your app

#Overview

When you decide to build an app for Hygraph, you must register it on the platform.

In this tutorial, we are only going to complete the basic information in the General, Permissions and Elements tabs.

If you want in depth information about the app registration process, along with all the options available, as well as all possible actions you can take in the registration form, click here.

Let's get started:

Navigate to Your apps in the project directory or your user settings, then click on the + Add new app button. This will lead you to the App registration form.

Your appsYour apps

#General

In the General tab of the app registration process, fill in the following information:

App registration - GeneralApp registration - General

  • Name: This is the name of your app. For this example, write App SDK Demo.
  • Description: A description for what your app does. For this example, write Example App Framework Application.
  • Avatar URL: URL that indicates where your logo is hosted. For this example, use https://i.pravatar.cc/300?img=69.
  • API ID: Write your API ID here. The ID is globally unique, so the form will let you know if the name is taken. This field only allows alphanumeric characters, underscores and hyphens, and you must start with a lowercase letter. This field becomes read-only once the app is created.
  • Setup URL: The setup URL is the form that displays when you install an app for the first time in Hygraph. For this example, write http://localhost:3000/setup.

#Permissions

This section shows the access details of your app.

App registration - PermissionsApp registration - Permissions

For this tutorial, we suggest you give read/write permissions but you can select your own.

Check out this document to check what each permission does.

#Elements

App registration - elementsApp registration - elements

#Field element

  • Elements: Add an element by clicking on + Add element:
    • Name: Name of your element. For this example, write Custom field.
    • API ID: Your element's API ID. For this example, write appCustomField.
    • Type: This is the element type. For this example, select field from the dropdown menu.
    • URL: The element's dedicated URL. For this example, write http://localhost:3000/custom-field.
    • Description: It's the description that will appear under your field name in the Schema. For this example, write Custom field.

After you've filled in all the information provided for this example, you can save your app by clicking on the Register app button.

The next step is to develop your application. Click here to continue.

#Sidebar element

  • Elements: Add an element by clicking on + Add element:
    • Name: Name of your element. For this example, write Google SERP Preview.
    • API ID: Your element's API ID. For this example, write appFormSidebar.
    • Type: This is the element type. For this example, select formSidebar from the dropdown menu.
    • URL: The element's dedicated URL. For this example, write http://localhost:3000/google-serp-preview.
    • Description: It's the description that will appear under your field name in the Schema. For this example, write Google SERP Preview.

After you've filled in all the information provided for this example, you can save your app by clicking on the Register app button.

#Page element

  • Elements: Add an element by clicking on + Add element:
    • Name: Name of your element. For this example, write Custom page view.
    • API ID: Your element's API ID. For this example, write custom-page-view.
    • Type: This is the element type. For this example, select page from the dropdown menu.
    • URL: The element's dedicated URL. For this example, write http://localhost:3000/page.
    • Description: It's the description that will appear under your field name in the Schema. For this example, write Custom page view.

After you've filled in all the information provided for this example, you can save your app by clicking on the Register app button.

#Resources

  • App Framework: Overview to our App Framework, which extends Hygraph capabilities, offering the possibility of creating your own custom apps and sharing them with other users.
  • Migrate to apps: A guide on migrating from UIX to app.
  • Register an app: Documentation for developers on how to register an app on the Hygraph platform.
  • Using app tokens: Document on how to generate an app token for your app during installation.
  • Install an app: Step by step guide on how to install an app in your Hygraph project.
  • Delete an app: Documentation for developers on how to delete an app you have created.
  • Next.js starter: Document that guides you through the process of developing an app with a custom field using our Next.js starter.
  • API Reference: Our App Framework API Reference.