Request widget URL

Get an embeddable URL for integrating a widget into your website or app. The URL expires after ten minutes or upon first use, whichever occurs first. You'll need to obtain a new URL each time the page loads or reloads.

Include the widget_type in the request body to specify which widget you want to embed—the Connect Widget, a Personal Financial Management widget, or an Insights widget. Some request parameters are specific to certain widget types.

To embed the Connect Widget, set widget_type to connect_widget.

For a full list of available widget types, see Widget Types.

POST

/users/{user_identifier}/widget_urls

Path Parameters

Field	Required	Type
user_identifier Use either the user id you defined or the MX-defined user guid. See MX-Defined GUIDs vs IDs Defined by You​.	Required	String

Header Parameters

Field	Required	Type
Accept-Version MX Platform API version.	Required	String
Accept-Language The desired language of the widget.	Optional	String
X-CALLBACK-PAYLOAD The base64 encoded string defined in this header will be returned in the Member and Member Data Updated webhooks. This allows you to trace user interactions and workflows initiated externally and internally in the MX Platform. Max 1024 characters.	Optional	String

Request Body

The widget_url configuration options.

Field	Required	Type
widget_url	Required	Object

Loading...