# Scripts ## JS Apps API Expose a manifest of approved scripts for your app to consume. Use this to know **what to load** and **where itโ€™s intended to run** inside your hybrid / mobile setup. :::highlight gray ๐Ÿ“Œ This endpoint does not execute anything by itself. It only returns configuration and script sources for your app to use. ::: --- ## GET `/api/v1/scripts` **Auth:** Project-specific **Content-Type:** `application/json` **Returns:** * `external_scripts` โ€” remote script URLs. * `app_scripts_bundle` โ€” inline snippets and reserved keys indicating where scripts are meant to be used. --- ## Example Response ```json { "external_scripts": [ { "id": 101, "src": null, "url": "https://cdn.example.com/scripts/tracking-abc123.js", "status": 2, "app_id": 5001, "version": 3 } ], "app_scripts_bundle": { "scripts": { "head": [ "" ], "global_head_script": [ "" ] }, "params": { "snapchatPixelId": "...", ... } } } ``` --- ## Field Details ### `external_scripts` Remote JS files hosted and approved by the platform. * `url` โ€” absolute URL to the script file. * Other fields (`id`, `status`, `app_id`, `version`) support identification and versioning. Intended usage: load these URLs as normal script files in your chosen runtime. --- ### `app_scripts_bundle` Inline scripts plus reserved keys. * `scripts.head` Inline snippets intended for a ``-like context (early load). * `global_head_script` Snippets intended to run once globally (shared initialization, loaders, etc.). * `purchase_event` Snippets intended to run once a purchase is completed. * `product_details_event` Snippets intended to run once a product's detail page is viewed. * `add_to_cart_event` Snippets intended to run once add to cart is executed. * `remove_from_cart_event` Snippets intended to run once remove item from cart is executed. * `start_checkout_event` Snippets intended to run once the checkout page is started. These should already be covered by the existing checkout page HTML. * `params` Contains identifiers like pixel ids or app ids. These map to function or event names in JavaScript. At this stage they serve as predefined wiring points; dedicated tracking/analytics scripts will be provided separately via URLs and can be obtained through this manifest when available. --- ## Integration Overview - Fetch `/api/v1/scripts` from your native code. - Load `external_scripts` URLs and inline snippets inside your WebView (e.g. via injected scripts or startup HTML). - Use `head` / `global_head_script` placement semantics as guidance for when those scripts should run. - Treat `/api/v1/scripts` as a remote config describing which scripts exist. - Use `external_scripts` and inline snippets primarily within WebViews or well-defined extension points. - `params` keys give you stable names to hook into once the corresponding tracking scripts are available. --- Retrieve `/api/v1/scripts` during your app's initialization or configuration phase. Inspect `external_scripts` and `app_scripts_bundle` to see which scripts and reserved keys are available. Inject or reference these scripts according to your appโ€™s architecture (hybrid WebView or JS-based). Future tracking scripts can be added via new URLs surfaced by the same manifest.