{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/chatlayer/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Fields schema","siteUrl":"https://developers.sinch.com","llmstxt":{"title":"Sinch Developer Documentation","description":"LLMs.txt containing a map of all the documentation files for Sinch.","sections":[{"title":"Numbers API","description":"The Numbers API enables you to search for, view, and activate numbers. It's considered a precursor to other APIs in the Sinch product family. The numbers API can be used in tandem with any of our APIs that perform messaging or calling.","includeFiles":["docs/numbers/**/*.md","docs/numbers/**/*.yaml"],"excludeFiles":["docs/numbers/index.md"]},{"title":"Conversation API","description":"Send and receive messages globally on many popular channels with ease and confidence when using Sinch's Conversation API. Conversation API is the preferred API for sending mobile messages on SMS and other social channels with Sinch. It is a simple API with unified error messages, consistent request payloads, and common webhook payloads that are channel-agnostic.","includeFiles":["docs/conversation/**/*.md","docs/conversation/**/*.yaml"],"excludeFiles":["docs/conversation/index.md"]},{"title":"Voice API","description":"The Voice API works as a big telephony switch. The Voice API handles incoming phone calls (also known as incoming call “legs”), sets up outgoing phone calls (or outgoing call “legs”), and bridges the two. The incoming call leg may come in over a data connection (from a smartphone or web application using the Sinch SDKs) or through a local phone number (from the PSTN network). Similarly, the outgoing call leg can be over data (to another smartphone or web application using the Sinch SDKs) or the PSTN network.","includeFiles":["docs/voice/**/*.md","docs/voice/**/*.yaml"],"excludeFiles":["docs/voice/index.md"]},{"title":"Voice API v2","description":"The Voice API works as a big telephony switch. The Voice API handles incoming phone calls (also known as incoming call “legs”), sets up outgoing phone calls (or outgoing call “legs”), and bridges the two. The incoming call leg may come in over a data connection (from a smartphone or web application using the Sinch SDKs) or through a local phone number (from the PSTN network). Similarly, the outgoing call leg can be over data (to another smartphone or web application using the Sinch SDKs) or the PSTN network.","includeFiles":["docs/voice-2.0/**/*.md","docs/voice-2.0/**/*.yaml"],"excludeFiles":["docs/voice-2.0/index.md"]},{"title":"Verification API","description":"The Verification API is a platform for phone number verification. It consists of the API and different software development kits (the Sinch SDKs) that you integrate with your smartphone or web application and cloud based back-end services. Together they enable SMS, Flashcall, Phone Call and Data verification in your application.","includeFiles":["docs/verification/**/*.md","docs/verification/**/*.yaml"],"excludeFiles":["docs/verification/index.md"]},{"title":"Provisioning API","description":"Provisioning API allows you to programmatically set up your senders, accounts and templates on your favorite messaging platforms on the Conversation API. For now, you can create your first WhatsApp channel through Meta's Embedded sign up, you can configure your first SMS App and configure your webhooks. As development continues, we will be adding the most commonly used channels.","includeFiles":["docs/provisioning-api/**/*.md","docs/provisioning-api/**/*.json"],"excludeFiles":["docs/provisioning-api/index.md"]},{"title":"Elastic SIP Trunking API","description":"With Elastic SIP Trunking you can create and manage your SIP trunks and phone numbers programmatically.","includeFiles":["docs/est/**/*.md","docs/est/**/*.yaml"],"excludeFiles":["docs/est/index.md"]},{"title":"Fax API","description":"Send and receive HIPAA compliant faxes on our modern fax platform using our developer-friendly API.","includeFiles":["docs/fax/**/*.md","docs/fax/**/*.yaml"],"excludeFiles":["docs/fax/index.md"]},{"title":"In-app Voice and Video SDK","description":"The In-app Voice and Video SDK enables you to add voice and video calling capabilities directly into your mobile or web application using the Sinch SDKs.","includeFiles":["docs/in-app-calling/**/*.md"],"excludeFiles":["docs/in-app-calling/index.md"]},{"title":"Number Lookup API","description":"The Number Lookup API is designed to provide in-depth information about phone numbers, helping enterprises enhance their communication strategies and prevent fraud. By identifying the type of phone line (for example, mobile, landline, VoIP) and the associated carrier, the API allows businesses to optimize routing, reduce unnecessary costs, and improve customer engagement.","includeFiles":["docs/number-lookup-api-v2/**/*.md","docs/number-lookup-api-v2/**/*.yaml"],"excludeFiles":["docs/number-lookup-api-v2/index.md"]},{"title":"Functions","description":"Serverless compute for voice and messaging. Deploy your code and Sinch routes live calls and messages to it — no infrastructure to run.","includeFiles":["docs/functions/functions/**/*.md","docs/functions/concepts/**/*.md","docs/functions/reference/**/*.md"],"excludeFiles":["docs/functions/functions/index.md"]},{"title":"CLI","description":"One command line for every Sinch API and the full Functions lifecycle — scaffold, run locally, deploy, and manage.","includeFiles":["docs/functions/cli/**/*.md"],"excludeFiles":["docs/functions/cli/index.md"]}]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"fields-schema","__idx":0},"children":["Fields schema"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The fields schema is the one that describes how the UI of your plugin should look like. It has access to a variety of UI"," ","fields which it can show in the UI as the form data for the users to put their input. Each Field schema creates a UI"," ","component in the form that you want to build."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"properties","__idx":1},"children":["Properties"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Property"},"children":["Property"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value Type"},"children":["Value Type"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["key *"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The unique identifier of the UI component. It is also the variable name when you try to access the value that user put on that component."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type"},"children":["string"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["label"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The Description of the UI component that you want to build."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type"},"children":["string"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["helpText"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The help text to show on the UI component that you want to build. It can be written as plain text or markdown."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type"},"children":["string"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Defines if the user needs to fill in the value in the UI component that you want to build."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean"},"children":["boolean"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The type of the UI component to be built. The values that it can have are:",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"1. boolean ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"2. text",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"3. dict",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"4. string",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"5. static-hook-url"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type"},"children":["string"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["choices"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The choices to be provided for the dropdown."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array"},"children":["Array"]}," of ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type"},"children":["strings"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["default"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The default value to be shown in the UI component that you want to build."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["dynamic"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The dynamic filed you want to show to the user."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array"},"children":["Array"]}," of ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type"},"children":["strings"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Detailed information on how to create each of the supported UI components can be found"," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/chatlayer/app-schema"},"children":["here"]},". ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/chatlayer/basics/references"},"children":["Interpolations"]}," can be used in these UI"," ","components."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Different types of UI components can be created using the different values in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," property."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"types-of-fields","__idx":2},"children":["Types of fields"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"boolean","__idx":3},"children":["Boolean"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you want to have a checkbox then you should use the boolean as the type. The value retrieved from this kind of UI"," ","component is always going to"," ","be ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean"},"children":["boolean"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"{\n    fields: [\n        {\n            key: \"private\",\n            label: \"Private\",\n            type: \"boolean\",\n            helpText:\n                \"Indicate whether these notes needs to be Private or Public ( Visible to everyone on the portal ).\",\n        },\n    ]\n}\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/boolean_field.7a0482c63d24e615b87654b7f237688664b6b1c385b88f01ed7ae8aae04946ed.9c5a8d95.png","alt":"boolean_field.png"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"text","__idx":4},"children":["Text"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you want to create a multiline Text-box component, then the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," property should be set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["text"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"\n{\n    fields: [\n        {\n            key: \"notes\",\n            label: \"Notes\",\n            type: \"text\",\n            helpText: \"The notes that need to be added to the Ticket.\",\n        },\n    ]\n}\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/text_field.5552c1bafe1662eb87f9a13d08e6dea7c52133be738154d1073c0a3c22d13899.9c5a8d95.png","alt":"text_field.png"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"dict","__idx":5},"children":["Dict"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you want to show dynamic key value pairs in the UI then ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dict"]}," component will come in handy. It is used to get"," ","the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object"},"children":["object"]},". It creates a"," ","dynamic list of two input fields in a line where the first one is considered as a key and the second one is the value."," ","Both key and value are of"," ","type ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String"},"children":["strings"]},"."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","header":{"controls":{"copy":{}}},"source":"      {\n    fields: [{\n        key: \"custom_fields\",\n        label: \"Custom fields\",\n        type: \"dict\",\n        helpText: \"Provide any aditional customs fields as **key/value** pairs\",\n    }]\n}\n","lang":"javascript"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/custom_field.7d58fefa8804b5540cb6cadb827319e3895226e6ceef44d1fe4587c02abee1ea.9c5a8d95.png","alt":"custom_field.png"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"dynamic-fields","__idx":6},"children":["Dynamic fields"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Certain fields may require data fetched from outside the system. Dynamic fields allow you to show external data a form"," ","and use the selected data elsewhere in the flow."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To create a dynamic field, the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dynamic"]}," field should follow a specific structure: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["resource_id.identifier.label"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["resource_id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The name of the resource you want to target, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/chatlayer/app-schema/resources-schema"},"children":["Resources"]}," for more information"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["identifier"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique ID differentiating one item from the other. This is the field name of an element of your resource data"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["label"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["This is a field inside a resource entry that will be used to visually show that element to a user."]}]}]}]}]}]},"headings":[{"value":"Fields schema","id":"fields-schema","depth":1},{"value":"Properties","id":"properties","depth":2},{"value":"Types of fields","id":"types-of-fields","depth":2},{"value":"Boolean","id":"boolean","depth":3},{"value":"Text","id":"text","depth":3},{"value":"Dict","id":"dict","depth":3},{"value":"Dynamic fields","id":"dynamic-fields","depth":3}],"frontmatter":{"title":"Fields schema | Chatlayer CLDK | Sinch","description":"Read about the fields schema.","seo":{"title":"Fields schema"}},"lastModified":"2026-10-15T13:48:51.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/chatlayer/app-schema/fields-schema","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}