{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/custom-cards/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Placeholders","description":"Start building with the Dixa API","siteUrl":"https://docs.dixa.io/","keywords":"dixa developer hub, api portal starter, api reference docs","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"placeholders","__idx":0},"children":["Placeholders"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can use ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["placeholders"]}," in the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Hook URL, headers"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["body"]}," of the request. The following placeholders are available:"]},{"$$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":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Variable"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Available channels"},"children":["Available channels"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{{calling_phone_number}}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The calling phone number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["voice"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sms"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["whatsapp"]}," conversations*"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{{called_phone_number}}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The called phone number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["voice"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sms"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["whatsapp"]},"  conversations*"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{{customer_phone_number}}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The customer's phone number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["voice"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sms"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["whatsapp"]},"  conversations*"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{{agent_phone_number}}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The agent's phone number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["voice"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sms"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["whatsapp"]},"  conversations*"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{{a_phone_number}}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Caller’s phone number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["originating number, and for non-voice channels, the requester's phone number if known"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{{b_phone_number}}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The destination's number (typical your organization number)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["voice"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sms"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["whatsapp"]},"  conversations*"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{{widget_id}}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The Dixa chat Widget ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Legacy Chat (not available on Dixa Messenger)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{{facebook_page_id}}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The Facebook Page ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["facebook"]}," conversations*"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{{sending_email}}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The sending email"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["email"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contactform"]}," conversations*"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{{receiving_email}}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The receiving email"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["email"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contactform"]}," conversations*"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{{agent_email}}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The assigned agent's email"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["all"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{{customer_email}}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The customer's email"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["email"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contactform"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["chat"]}," amd ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["messenger"]}," conversations*"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{{a_email}}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The sender's email address"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["for non-email address based channels, the requester's email if known"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{{b_email}}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The receiver’s email address"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["email"]}," conversations*"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{{csid}}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The conversation id in Dixa"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["all"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{{customer_external_id}}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The external id of a customer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Available for all channels, if ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalId"]}," was provided programatically for the requester/enduser."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["(*) Variables which have any invalid URL characters (eg. @ in email or + in phone number already ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["encoded for query string parameters"]}," (as an example `",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?email={{a_email}}"]},") if you use it in the hook URL. Being compliant with ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://tools.ietf.org/html/rfc3986#section-3.3"},"children":["RFC 3986"]}," encoding should not be applied if variable is a part of a path (as an example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/test/{{a_email}}"]},").",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"If the Hook URL contains any static query parameters, their values must be encoded with URL encoding."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["voice"]}," in the above table means channels using Dixa telephony, such as callbacks, voicemail and inbound/outbound phone calls."]}]},"headings":[{"value":"Placeholders","id":"placeholders","depth":1}],"frontmatter":{"seo":{"title":"Placeholders"}},"lastModified":"2026-04-09T11:32:42.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/custom-cards/placeholders","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}