Skip to content
Last updated

Widget Events

Quantiv delivers instant notifications to your registered webhook(s) when specific events occur related to widgets. These events include:

  • widget.created
  • widget.updated

Widget Created

The widget.created event occurs when Widget is created by your Client via API request or the Configuration Widget. The event data has the following structure:

{
  "id": "9f652023-b33b-4217-88fe-34ded545a075",
  "event": "widget.created",
  "data": {
    "object": {
      "referenceId": "1bab4a29-6a4e-47c5-a5ab-72e6b60d1f37",
      "widgetType": "roof-estimate",
      "status": "active",
      "link": "https://company-url-1.com?roof-estimate=open",
      "hostedLink": "https://app.your-estimate.com/widget/roof-estimate/6770dcbf-560b-40f9-abaa-8d872976d1ff",
      "qrCode": "https://quantiv.com/widgets/roof-estimate/images/widget-qr-code-1bab4a29-6a4e-47c5-a5ab-72e6b60d1f30.png",
      "hostedQrCode": "https://quantiv.com/widgets/roof-estimate/images/quantiv-qr-code-1bab4a29-6a4e-47c5-a5ab-72e6b60d1f30.png",
      "widgetScript": "<script src='https://widget.your-estimate.com/widgets/widget.min.js' data-widget-type='roof-estimate' data-reference-id='6770dcbf-560b-40f9-abaa-8d872976d1f1' ></script>",
      "elementType": "button",
      "elementLocation": "bottom_right",
      "elementSize": "medium",
      "buttonText": "button text",
      "buttonTextColor": "#ffffff",
      "buttonBackgroundColor": "#696CFF",
      "bannerText": "banner text",
      "bannerBackgroundColor": "#fafafa",
      "primaryColor": "#696CFF",
      "secondaryColor": "#aaaaaa",
      "backgroundColor": "#F5F5F9",
      "cardBackgroundColor": "#ffffff",
      "textColor": "#22303EE6",
      "linkColor": "#696CFF",
      "footerCompanyName": "company name 1",
      "footerPrivacyPolicyLink": "company-url-1.com/privacy",
      "footerTermsOfUseLink": "company-url-1.com/terms",
      "companyUrl": "company-url-1.com",
      "installedPrice": "801.13",
      "headerLogoUrl": "https://quantiv.com/widgets/roof-estimate/images/header-logo-1bab4a29-6a4e-47c5-a5ab-72e6b60d1f30.png",
      "footerLogoUrl": "https://quantiv.com/widgets/roof-estimate/images/footer-logo-1bab4a29-6a4e-47c5-a5ab-72e6b60d1f30.png"
    }
  },
  "timestamp": "2025-06-27T08:21:44.699Z",
  "mode": "prod",
  "version": "1.0",
  "metadata": {}
}

Widget Updated

The widget.updated event occurs when Widget is updated by your Client via API request or the Configuration Widget. The event data has the following structure:

{
  "id": "6dcff742-eff8-41b9-a1d4-69372d074497",
  "event": "widget.updated",
  "data": {
    "object": {
      "referenceId": "bbee30c2-0357-4290-b522-735818c57be1",
      "widgetType": "roof-estimate",
      "status": "active",
      "link": "https://www.quantiv.io?roof-estimate=open",
      "hostedLink": "https://app.your-estimate.com/widget/roof-estimate/6770dcbf-560b-40f9-abaa-8d872976d1f1",
      "qrCode": "https://quantiv.com/widgets/roof-estimate/images/widget-qr-code-bbee30c2-0357-4290-b522-735818c57be1.png",
      "hostedQrCode": "https://quantiv.com/widgets/roof-estimate/images/quantiv-qr-code-bbee30c2-0357-4290-b522-735818c57be1.png",
      "widgetScript": "<script src='https://widget.your-estimate.com/widgets/widget.min.js' data-widget-type='roof-estimate' data-reference-id='6770dcbf-560b-40f9-abaa-8d872976d1ff' ></script>",
      "primaryColor": "#696CFF",
      "secondaryColor": "#aaaaaa",
      "backgroundColor": "#F5F5F9",
      "cardBackgroundColor": "#ffffff",
      "textColor": "#22303EE6",
      "linkColor": "#696CFF",
      "removeFooterLogo": false,
      "footerCompanyName": "Test",
      "footerPrivacyPolicyLink": "https://www.quantiv.io/privacy-policy",
      "companyUrl": "https://www.quantiv.io",
      "installedPrice": "600",
      "headerLogoUrl": "https://quantiv.com/widgets/roof-estimate/images/header-logo-bbee30c2-0357-4290-b522-735818c57be1.png",
      "footerLogoUrl": "",
      "elementType": "banner",
      "elementSize": "medium",
      "elementLocation": "top",
      "buttonText": "Get Your Instant Estimate",
      "buttonTextColor": "#FFFFFF",
      "buttonBackgroundColor": "#696CFF",
      "bannerText": "Check your roof estimate in 60 seconds",
      "bannerBackgroundColor": "#F5F5F9"
    },
    "previousObject": {
      "referenceId": "bbee30c2-0357-4290-b522-735818c57be1",
      "widgetType": "roof-estimate",
      "status": "active",
      "link": "https://www.quantiv.io?roof-estimate=open",
      "hostedLink": "https://app.your-estimate.com/widget/roof-estimate/6770dcbf-560b-40f9-abaa-8d872976d1ff",
      "qrCode": "https://quantiv.com/widgets/roof-estimate/images/widget-qr-code-bbee30c2-0357-4290-b522-735818c57be1.png",
      "hostedQrCode": "https://quantiv.com/widgets/roof-estimate/images/quantiv-qr-code-bbee30c2-0357-4290-b522-735818c57be1.png",
      "widgetScript": "<script src='https://widget.your-estimate.com/widgets/widget.min.js' data-widget-type='roof-estimate' data-reference-id='6770dcbf-560b-40f9-abaa-8d872976d1ff' ></script>",
      "primaryColor": "#696CFF",
      "secondaryColor": "#aaaaaa",
      "backgroundColor": "#F5F5F9",
      "cardBackgroundColor": "#ffffff",
      "textColor": "#22303EE6",
      "linkColor": "#696CFF",
      "removeFooterLogo": "true",
      "footerCompanyName": "Test123",
      "footerPrivacyPolicyLink": "https://www.quantiv.io/privacy-policy",
      "companyUrl": "https://www.quantiv.io",
      "installedPrice": "600",
      "headerLogoUrl": "https://quantiv.com/widgets/roof-estimate/images/header-logo-bbee30c2-0357-4290-b522-735818c57be1.png",
      "footerLogoUrl": ""
    }
  },
  "timestamp": "2025-06-27T07:51:54.568Z",
  "mode": "prod",
  "version": "1.0",
  "metadata": {}
}
Previous page
Next page