embeddable/json-structure/embeddable-embed-config-structure.json at main · api-evangelist/embeddable · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/embeddable/refs/heads/main/json-structure/embeddable-embed-config-structure.json",
  "name": "EmbedConfig",
  "description": "Configuration object passed by a host application to initialize an embedded widget, JS SDK, or iframe experience.",
  "type": "object",
  "properties": {
    "provider": {
      "type": "string",
      "description": "Vendor providing the embeddable widget or SDK.",
      "example": "Stripe"
    },
    "widget_type": {
      "type": "string",
      "description": "Category of embeddable experience being rendered.",
      "enum": [
        "payment",
        "identity",
        "financial-link",
        "map",
        "media-player",
        "chat",
        "scheduling",
        "form",
        "analytics-dashboard",
        "video-conference",
        "auth",
        "comments",
        "other"
      ],
      "example": "payment"
    },
    "embed_mode": {
      "type": "string",
      "description": "How the widget is mounted into the host page.",
      "enum": [
        "inline",
        "iframe",
        "popup",
        "drawer",
        "modal",
        "side-tab",
        "full-page",
        "script-tag",
        "web-component"
      ],
      "example": "inline"
    },
    "container_selector": {
      "type": "string",
      "description": "CSS selector or DOM id of the host element that should mount the widget.",
      "example": "#payment-element"
    },
    "publishable_key": {
      "type": "string",
      "description": "Public, browser-safe key issued by the provider that authorizes the embed.",
      "example": "pk_test_51Hxxxxxxxxxxxxxxxxxxxxxx"
    },
    "session_token": {
      "type": "string",
      "description": "Short-lived, server-issued token scoped to a single embed session.",
      "example": "link-sandbox-abc123-9d4e-4f9a-9c4d-1234567890ab"
    },
    "theme": {
      "type": "object",
      "description": "Theming overrides applied to the embedded experience.",
      "properties": {
        "mode": {
          "type": "string",
          "enum": ["light", "dark", "auto"],
          "example": "light"
        },
        "primary_color": {
          "type": "string",
          "example": "#635BFF"
        },
        "font_family": {
          "type": "string",
          "example": "Inter, system-ui, sans-serif"
        },
        "border_radius": {
          "type": "string",
          "example": "8px"
        }
      }
    },
    "locale": {
      "type": "string",
      "description": "BCP 47 locale code used to localize the embed UI.",
      "example": "en-US"
    },
    "allowed_origins": {
      "type": "array",
      "description": "Host origins permitted to load this embed.",
      "items": {
        "type": "uri"
      },
      "example": [
        "https://app.example.com",
        "https://staging.example.com"
      ]
    },
    "events": {
      "type": "array",
      "description": "Lifecycle and domain events the host wants to subscribe to.",
      "items": {
        "type": "string"
      },
      "example": [
        "ready",
        "success",
        "error",
        "dismiss"
      ]
    }
  },
  "required": [
    "provider",
    "widget_type",
    "embed_mode"
  ]
}