# biticaret.extension.toml keys

> The keys in biticaret.extension.toml for each extension type, their types and descriptions.

This page is generated from the source code. `a.b` denotes key `b` in table `[a]`, and `a[].b` denotes key `b` in each item of the `[[a]]` array of tables. For how these files work, see [App configuration files](../apps/configuration.md).

## type = "theme"

| Key | Type | Description |
| :--- | :--- | :--- |
| `type` | string | Extension type: theme. |
| `name` | string | Display name of the theme extension. Blocks, snippets and assets live in blocks/, snippets/ and assets/ alongside this file; each block declares its name, target and settings in its {% schema %} tag. |

## type = "function"

| Key | Type | Description |
| :--- | :--- | :--- |
| `type` | string | Extension type: function. |
| `handle` | string | Function identifier (function_id): lowercase letters, digits, - and _, at most 50 characters. |
| `function_type` | string | Function type. See the Checkout functions page. |
| `title` | string | Display name of the function in the admin, at most 100 characters. |
| `input_metafields` | string array | Metafields passed into the function: customer \<namespace>.\<key> fields (for cart_transform, the line variant's metafields, restricted to the app's own namespaces) and shop.\<namespace>.\<key> fields (restricted to the app's own namespaces). |
| `build.command` | string | Shell command executed by app build inside the function folder (via sh -c). |
| `build.path` | string | Path to the compiled .wasm binary relative to the extension folder; packaged as functions/\<folder>.wasm. |

## type = "ui_extension"

| Key | Type | Description |
| :--- | :--- | :--- |
| `type` | string | Extension type: ui_extension. |
| `handle` | string | Extension identifier (extension_id): lowercase letters, digits, - and _, at most 50 characters. |
| `name` | string | Display name of the extension in the admin, at most 100 characters. |
| `target` | string | Default target slot where the extension renders. See the UI extension targets page. |
| `targets` | string array | Targets between which the store can move the extension; must include target and stay on the same surface (checkout.* or admin.*). If empty, only target is permitted. |
| `module` | string | Path to the extension's .js module relative to the extension folder; packaged as extensions/\<folder>.js. |
| `capabilities.network_access` | boolean | Allows the extension to issue fetch requests to the app's own backend. |
| `metafields` | string array | Metafields exposed to the extension; supported on checkout.* targets only. |
| `settings.fields[].key` | string | Unique key of the setting field. |
| `settings.fields[].type` | string | Field type: single_line_text_field, multi_line_text_field, boolean, number_integer or number_decimal. |
| `settings.fields[].name` | string | Field label shown to the store. |
| `settings.fields[].description` | string | Field help text shown to the store. |
| `settings.fields[].choices` | string array | Allowed options for a single-choice setting (2 to 20 items); valid for single_line_text_field only. |
| `settings.fields[].default` | a value of the setting's type | Default value matching the setting field's type. |

## type = "web_pixel"

| Key | Type | Description |
| :--- | :--- | :--- |
| `type` | string | Extension type: web_pixel. |
| `handle` | string | Pixel identifier (pixel_id): lowercase letters, digits, - and _, at most 50 characters. |
| `name` | string | Display name of the pixel in the admin. |
| `module` | string | Path to the pixel's .js module relative to the extension folder; packaged as extensions/\<folder>.js. |
| `consent` | string | Required visitor cookie consent category: analytics or marketing. Events are delivered only when granted. |
| `settings.fields[].key` | string | Setting key: starts with a lowercase letter; lowercase letters, digits and _, at most 40 characters. Read in the pixel under init.data.settings. |
| `settings.fields[].type` | string | Field type: string (at most 500 characters) or string_list (array of strings). Settings are written via the API using write_pixels. |
| `settings.fields[].required` | boolean | When true, the setting is required; while any required setting is empty the pixel does not run and Customer events shows it as not configured. |
