# Manifest

The component manifest provides information about a component (such as name, icon, author, description and properties) in a JSON text file. The manifest file must be named **component.json**.

Example manifest file:

```
{
    "name": "appmixer.utils.controls.OnStart",
    "author": "Martin Krčmář <martin@client.io>",
    "label": "On Flow Start",
    "description": "This trigger fires once and only once the flow starts.",
    "icon": "data:image/svg+xml;base64,PD94bWwgdmV...",
    "outPorts": [
        {
            "name": "out",
            "schema": {
                "properties": {
                    "started": {
                        "type": "string",
                        "format": "date-time"
                    }
                },
                "required": [ "started" ]
            },
            "options": [
                { "label": "Start time", "value": "started" }
            ]
        }
    ]
}
```

## Members

* [name](/6.0/v4/component-definition/manifest/name.md)

  Name of the component.
* label

  Label that will be used instead of `name.`
* [icon](/6.0/v4/component-definition/manifest/icon.md)

  Component icon.
* [marker](/6.0/v4/component-definition/manifest/marker.md)\
  Component badge icon giving users extra context.
* [author](/6.0/v4/component-definition/manifest/author.md)

  Author.
* [description](/6.0/v4/component-definition/manifest/description.md)

  Description.
* [auth](/6.0/v4/component-definition/manifest/auth.md)

  Authentication mechanism if the component requires authentication.
* [quota](/6.0/v4/component-definition/manifest/quota.md)

  Parameters for the quota module used in the component (to conform with API usage limits).
* [properties](/6.0/v4/component-definition/manifest/properties.md)

  Properties of the component.
* [inPorts](/6.0/v4/component-definition/manifest/inports.md)

  Definition of the input of the component and how data transforms before it is processed by the component.
* [outPorts](/6.0/v4/component-definition/manifest/outports.md)

  Definition of the output of the component and variables that other connected components can use in their input.
* [firePatterns](/6.0/v4/component-definition/manifest/firepatterns.md)

  Requirements for the component input messages to decide whether the component is ready to fire.
* [tick](/6.0/v4/component-definition/manifest/tick.md)

  Enable polling mechanism on the component.
* [private](/6.0/v4/component-definition/manifest/private.md)\
  Make component private to hide it from the user.
* [webhook](/6.0/v4/component-definition/manifest/webhook.md)\
  Make component "webhook"-type meaning it can receive HTTP requests.
* [state](https://docs.appmixer.com/appmixer/v/v3/component-definition/manifest/state)\
  Controls whether component's internal state is preserved across flow restarts.


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.appmixer.com/6.0/v4/component-definition/manifest.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.