Customize the Response

You can customize the response of Addons so you only return what's truly important. There are a few important things to know when you do so.

Xano allows you to customize the response of an Addon (or any query) so that you can get rid of any unwanted data in your response.

There's two different places that you can customize the response of an Addon, so it's important to know how they work together and when they affect one another.

How are the Addon responses affected when customizing it from the Library versus in the query?

The two places to customize the response of an Addon are from the Library and from the query, which the Addon is attached to.

  • Customizing the response of an Addon from the Library is like setting a β€œdefault” response for the Addon, this default would be reflected anytime you use that Addon in a query and do not choose to customize the response output.

  • If you choose to customize the response of an Addon from within the query that it is attached to. Then those settings will lock in for that Addon in that specific query. As long as customize response is selected there, then any changes to the response made in the Library will not affect it.

  • If you have customize response selected in either place for an Addon and you add a new field to your database then that field will not be added to the response. You must either select it manually or if you have customize response not selected then it will automatically show up.

Customizing the response from within the query that the Addon is attached to

Open the query all records function where the Addon is attached to. Then, navigate to the Output tab and click on the Addon to open the settings.

Select "Customize Response" from the Addon's settings.

Click the select box in order to view the fields of the Addon's response. Deselect anything you wish to not include in the response.

Customize the response of an Addon from the Library

Navigate to the Addon page in the Library and open the Addon. First, click on the function of the Addon. Next, open the Output tab. Then, click on "Customize."

After follow the same steps from the previous method. Select customize response, then deselect anything you wish to exclude from the response of the Addon and save.

Return as Self

You have the option to change they key of which the addon return is nested under in the Output tab.

You can also leave this value blank to return as 'self', which means that the output of the addon does not live in a separate key, and is instead merged directly into the parent's results.

Last updated