> For the complete documentation index, see [llms.txt](https://community-test.logicnets.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://community-test.logicnets.com/release-9/design-considerations-and-frameworks/frameworks/feedback-portal-framework/feedbackapi-framework.md).

# FeedbackAPI Framework

## Description

The *FeedbackAPI Framework* enables you to create an external installation that can send feedback to a central server. You can use this framework in conjunction with the Feedback Portal Framework, where you can view submitted feedback.

## Create Your Application

You use the FeedbackAPI framework to send feedback from an application to a server, where the data is stored. This framework uses one endpoint, which is 'send'. When this endpoint is invoked, the system saves this information in the project\_feedback table on the server.

The steps below allow you to create a sample FeedbackAPI to show you how your feedback API might work. The data captured for this example is static, and we recommend you work with LogicNets to create a more customized system.

1. In your Designer account, click on the icon to create a new project.
2. Enter the name of your project and click ***Create***.

   ![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-a62eff360fa4e01e310506bde566e1b271127577%2F84a76e86-ad3e-43b9-9242-92b312b05b11.png?alt=media)
3. Select ***based on framework*** from the *Type* dropdown menu.
4. Select ***FeedbackAPI*** from the *Framework* dropdown menu and click ***Create***.

   ![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-f907f61c8d4716f8ef96df9bdd112e1b4e26cb29%2F88378533-5bac-4bcc-9229-7267960fa9e0.png?alt=media)

## Sending Feedback

LogicNets sends feedback using a URL that consists of three parts: the host name, the startcode of your published FeedbackAPI application, and the word "send":

*https\:////send*

## Configuration

When the system receives feedback, it can send a confirmation email to the user who submitted it. The system can also send a notification email to the user whose email is configured in the configuration settings. To configure these emails, click on your project folder in the project list. Click the *Framework* tab for your project.

![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-55e705cf197356674950badae91eba9a562729f6%2Fe767964d-45ae-4f47-988d-0172a51a5dc9.png?alt=media)

* **Send to email:** The email address to whom the system should send an email when a feedback is submitted.
* **Send from email:** The email address that appears in the *From* line when the system sends the feedback.

## Test Your Application

You can test this sample API from your Designer account. To test your project, click on your project folder and then click the ***Test*** button.

![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-bd42e5777da5e505d07ad7f5deac792b676b6875%2Fa0485359-d8bf-46ad-857c-6de898d193c4.png?alt=media)

For your test, enter the following selections in the test screen:

![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-cea18a778b9f9b941b751711e21f7421ac0ce9c9%2F06c9a073-5b8e-4dc0-86e0-80163e757103.png?alt=media)

Click ***Submit request***. Note: Depending on the size of your screen, you may need to scroll the top portion of the page to see the submit button. Once you submit your feedback, the system will display the test status code and output at the section on the bottom of the screen.

![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-55942dd5b11486dc3d0783a093e4bf6e9f346700%2F9bce80c9-ba8c-4d39-990e-5708f6b6e0bb.png?alt=media)

You can configure your application to send the feedback wherever you want, however, LogicNets also provides the [Feedback Portal Framework](/release-9/design-considerations-and-frameworks/frameworks/feedback-portal-framework.md), which allows you to create a portal in which you can view submitted feedback.

To see the feedback you sent in the test setup above, create a test of the Feedback Portal by doing the following:

1. In your Designer account, click on the icon to create a new project.
2. Enter the name of your project and click ***Create***.

   ![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-54d9bac03e408d00806e50e281f779853d62098d%2F0d8deae9-ca60-4d6f-9f03-4c34a62fdb0e.png?alt=media)
3. Select based on framework from the *Type* dropdown menu.
4. Select ***FeedbackPortal*** from the *Framework* dropdown menu and click ***Create***.
5. From your project's main menu, click ***Test***.

![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-2d6eb2121fd83930b4ac30814f04fb7ce9adc70c%2Fa4611aa6-c35c-46ec-8181-1183465a0608.png?alt=media)

The system displays the data you entered.

![](https://2802811211-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FdFhfexCjZ5JMhwGzzywq%2Fuploads%2Fgit-blob-43d5a8233ffebe863209c4477b0350f378c3e61a%2F7b0074a1-862c-4728-b6a9-1127d6deedae.png?alt=media)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://community-test.logicnets.com/release-9/design-considerations-and-frameworks/frameworks/feedback-portal-framework/feedbackapi-framework.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.