widgets

Request widget URL

Changed on

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_guid}/widget_urls

Request

  • Base URL
    https://int-api.mx.com
  • URL
    https://int-api.mx.com/users/{user_guid}/widget_urls
  • Auth
    HTTP basic

Path parameters

user_guidstring required

The unique identifier for a user, beginning with the prefix USR-.

Headers

Accept-Languagestring

The desired language of the widget.

X-CALLBACK-PAYLOADstring

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.

Request body

Example request

{
  "widget_url": {
    "client_redirect_url": "https://{yoursite.com}",
    "color_scheme": "light",
    "current_institution_code": "mxbank",
    "current_institution_guid": "INS-f1a3285d-e855-b61f-6aa7-8ae575c0e0e9",
    "current_member_guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
    "include_transactions": true,
    "iso_country_code": [
      "US",
      "CA"
    ],
    "mode": "aggregation",
    "oauth_referral_source": "BROWSER",
    "ui_message_version": 4,
    "use_cases": [
      "PFM"
    ],
    "widget_type": "connect_widget"
  }
}

Response

OK

Changes

  • e74cd2b059b5Revision changes
    • info

      api tag widgets added

    • info

      api tag mx_platform removed

    • info

      added the new optional header request parameter X-CALLBACK-PAYLOAD

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      the request property / became nullable

    • info

      the request property / became nullable

  • bcb952b55c19Revision changes
    • info

      added the new optional request property /