Event Types & Payloads

  1. Question Set
  2. Quote Request
  3. Application Form

Question Set

Triggered when a question set is completed

Question Set payload

Key Type Description
application_form_id string UUID of the application form
answers array The answers that were completed by the user
code string Programmatic identifier for the question set
completed boolean Whether this question set is completed
completed_at string The time the question set was completed
id string UUID of the question set
reference_id string Application form reference ID
tenant string Tenant name
title string User facing title for the question set

Question Set payload example

{
  "id": "7d6583a2-5742-46d9-acaa-1088ccc51ec1",
  "completed_at": "2019-11-21 13:44:24 -0500",
  "title": "Contact Information",
  "code": "contact_info",
  "completed": true,
  "application_form_id": "1fb718d9-7819-4f2d-bda9-2e0645c0f94a",
  "reference_id": "ABC-789-JKL",
  "tenant": "ABC Brokerage",
  "answers": [
    {
      "code": "mqs_naics",
      "value": "Advertising agencies",
      "question_text": "What's your main profession?"
    },
    {
      "code": "mqs_first_name",
      "value": "John",
      "question_text": "Business owner's first name"
    },
    {
      "code": "mqs_last_name",
      "value": "Doe",
      "question_text": "Last name"
    },
    {
      "code": "mqs_email",
      "value": "john.doe@boldpenguin.com",
      "question_text": "Email address"
    },
    {
      "code": "mqs_phone",
      "value": "6145555555",
      "question_text": "Telephone number"
    },
    {
      "code": "mqs_business_name",
      "value": "Test Company",
      "question_text": "Business name"
    },
    {
      "code": "mqs_address_1",
      "value": "100 E Broad St",
      "question_text": "Physical business address"
    },
    {
      "code": "mqs_city",
      "value": "Columbus",
      "question_text": "City"
    },
    {
      "code": "mqs_state",
      "value": "Ohio",
      "question_text": "State"
    },
    {
      "code": "mqs_zipcode",
      "value": "43215",
      "question_text": "Zip code"
    }
  ]
}

Quote Request

Triggered when a quote request is completed or failed

Quote Request payload

Key Type Description
annual_price string Annual rate in USD
application_form_id string UUID of the application form
carrier string Carrier name
id string UUID of the quote request
monthly_price string Monthly rate in USD
products array Products included in the quote
recommended boolean Whether this quote request was recommended to the user
reference_id string Application form reference ID
request_status string Status of the quote request: completed, failed
score string Score used to rank this quote request
tenant string Tenant name

Quote Request payload example

{
  "request_status": "completed",
  "annual_price": "1032.0",
  "monthly_price": "86.0",
  "quote_number": "ABC123789",
  "score": "100.0",
  "id": "6d1e47a5-0d7b-43de-ad81-aaf11d6f4513",
  "products": [
    "Business Owner's Policy"
  ],
  "recommended": true,
  "carrier": "Big Carrier",
  "application_form_id": "1fb718d9-7819-4f2d-bda9-2e0645c0f94a",
  "reference_id": "ABC-789-JKL",
  "tenant": "ABC Brokerage"
}

Application Form

Triggered when an application form is quoted or inactive

Application Form payload

Key Type Description
answers array The answers that were completed by the user
cloned boolean Whether this application form has been cloned
created_at string The time the application form was created
finished_quote_requests_count number Number of quote requests that have finished
id string UUID of the application form
inactive boolean Whether this application form is inactive
locked boolean Whether this application form is locked
owner_id string UUID of the user that owns the application form
owner_is_guest boolean Whether the owner is a guest user
parent_id string UUID of the parent application form
question_sets array The question sets
quote_requests array The quote requests
quote_requests_count number Number of quote requests that were created
reference_id string Application form reference ID
state string Application form state: incomplete, in_progress, completed, quoted
tenant string Tenant name
updated_at string The time the application form was last modified

Application Form payload example

{
  "id": "1fb718d9-7819-4f2d-bda9-2e0645c0f94a",
  "owner_id": "c5dd8061-477b-4d16-a4f9-11aa1beb14f8",
  "parent_id": null,
  "locked": false,
  "state": "quoted",
  "reference_id": "ABC-789-JKL",
  "owner_is_guest": false,
  "quote_requests_count": 2,
  "finished_quote_requests_count": 2,
  "created_at": "2019-11-21 13:44:02 -0500",
  "updated_at": "2019-11-21 13:46:23 -0500",
  "cloned": false,
  "inactive": false,
  "tenant": "ABC Brokerage",
  "question_sets": [
    {
      "id": "39bfab6a-a5d7-4b17-927f-093e15b4b659",
      "completed_at": "2019-11-21 13:44:24 -0500",
      "title": "Contact Information",
      "code": "contact_info",
      "completed": true
    },
    {
      "id": "24707e72-f382-429e-a4aa-8a96963e6fe5",
      "completed_at": "2019-11-21 13:44:31 -0500",
      "title": "Select Coverage",
      "code": "coverage",
      "completed": true
    },
    {
      "id": "860a0bb2-c8c0-4f10-bc21-ac1a023bd096",
      "completed_at": "2019-11-21 13:44:31 -0500",
      "title": "General",
      "code": "general",
      "completed": true
    },
    {
      "id": "77a187af-f6da-46d2-91a3-a98088c825e1",
      "completed_at": "2019-11-21 13:44:51 -0500",
      "title": "MQS",
      "code": "master_question_set",
      "completed": true
    },
    {
      "id": "c286cc85-bf64-4ed9-9d1a-cb067eff6f42",
      "completed_at": "2019-11-21 13:45:44 -0500",
      "title": "Big Carrier",
      "code": "big_carrier",
      "completed": true
    },
    {
      "id": "b6a30ba2-039c-47b3-b117-c0e358479e71",
      "completed_at": "2019-11-21 13:45:50 -0500",
      "title": "Mega Carrier",
      "code": "mega_carrier",
      "completed": true
    }
  ],
  "answers": [
    {
      "code": "mqs_phone",
      "value": "6145555555",
      "question_text": "Telephone number"
    },
    {
      "code": "mqs_business_name",
      "value": "Test Company",
      "question_text": "Business name"
    },
    {
      "code": "mqs_address_1",
      "value": "100 E Broad St",
      "question_text": "Physical business address"
    },
    {
      "code": "mqs_naics",
      "value": "Advertising agencies",
      "question_text": "What's your main profession?"
    },
    {
      "code": "mqs_state",
      "value": "Ohio",
      "question_text": "State"
    },
    {
      "code": "mqs_first_name",
      "value": "John",
      "question_text": "Business owner's first name"
    },
    {
      "code": "mqs_last_name",
      "value": "Doe",
      "question_text": "Last name"
    },
    {
      "code": "mqs_email",
      "value": "john.doe@boldpenguin.com",
      "question_text": "Email address"
    },
    {
      "code": "mqs_zipcode",
      "value": "43215",
      "question_text": "Zip code"
    },
    {
      "code": "mqs_city",
      "value": "Columbus",
      "question_text": "City"
    },
    {
      "code": "mqs_has_fein",
      "value": "Yes",
      "question_text": "Does your business have a Federal Employer Identification Number (FEIN)?"
    },
    {
      "code": "mqs_building_stories",
      "value": 1,
      "question_text": "How many stories is this building?"
    },
    {
      "code": "mqs_building_year_built",
      "value": 2000,
      "question_text": "What is the approximate year the building you occupy was constructed?"
    },
    {
      "code": "mqs_building_construction",
      "value": "Frame",
      "question_text": "Which of the following describes the construction of your building?"
    },
    {
      "code": "mqs_currently_insured",
      "value": "Yes",
      "question_text": "Do you currently have insurance for this business?"
    },
    {
      "code": "mqs_legal_entity",
      "value": "LLC",
      "question_text": "What is your legal entity type?"
    },
    {
      "code": "mqs_fein",
      "value": "*********",
      "question_text": "Federal Employer Identification Number (FEIN)"
    },
    {
      "code": "mqs_year_established",
      "value": 2000,
      "question_text": "In what year did you start your business?"
    },
    {
      "code": "mqs_years_of_experience",
      "value": 20,
      "question_text": "How many years of experience do you have in this profession?"
    },
    {
      "code": "mqs_annual_policy",
      "value": "Yes",
      "question_text": "Does your business operate year round?"
    },
    {
      "code": "mqs_full_time_employees",
      "value": 0,
      "question_text": "How many full time associates do you currently employ?"
    },
    {
      "code": "mqs_part_time_employees",
      "value": 0,
      "question_text": "How many part time associates do you currently employ?"
    },
    {
      "code": "mqs_estimated_annual_revenue",
      "value": 200000,
      "question_text": "What do you estimate your annual gross revenue will be for the next 12 months?"
    },
    {
      "code": "mqs_building_ownership",
      "value": "Yes",
      "question_text": "Do you own the building at this location?"
    },
    {
      "code": "mqs_area_occupied",
      "value": 2000,
      "question_text": "Approximately how many square feet does your business occupy of this building (not total square feet of building)?"
    },
    {
      "code": "mqs_building_square_footage",
      "value": 2000,
      "question_text": "What is the approximate total square footage of the building you occupy (including space you don't occupy)"
    },
    {
      "code": "mqs_coverage_start_date",
      "value": "2019-12-05",
      "question_text": "When would you like your policy to start?"
    },
    ...
  ],
  "quote_requests": [
    {
      "request_status": "completed",
      "annual_price": "1032.0",
      "monthly_price": "86.0",
      "quote_number": "ABC123789",
      "score": "100.0",
      "id": "6d1e47a5-0d7b-43de-ad81-aaf11d6f4513",
      "products": [
          "Business Owner's Policy"
      ],
      "recommended": true,
      "carrier": "Big Carrier"
    },
    {
      "request_status": "completed",
      "annual_price": "1304.0",
      "monthly_price": null,
      "quote_number": "456321789",
      "score": "5.125",
      "id": "5e557181-395c-4a75-9537-b094926a480e",
      "products": [
          "Business Owner's Policy"
      ],
      "recommended": false,
      "carrier": "Mega Carrier"
    }
  ]
}

results matching ""

    No results matching ""