Skip to content

INTAKE_COMPLETE

This event is fired after a user finishes entering their information.

When and what fires this event?

If this event is defined on a product, and it has actions that are enabled:

  • CoPilot: fires this event after a client's information has been entered in the Account Builder;
  • Storefront: fires this event after a user finishes entering their information;
  • Fired externally via API on-demand.

Request payload

POST: https://api.{ENV}.dais.com/ioi/v3/event/fire

curl --location --request POST 'https://api.{ENV}.dais.com/ioi/v3/event/fire' \
--header 'Authorization: Basic <yourAuthHere>' \
--header 'Content-Type: application/json' \
--data-raw '{
      "lineId": "<UUID of the product>",
      "type": "INTAKE_COMPLETE",
      "payload": {
        "referrer": "<referrer>",
        "intake": {
          "<qid>": {
            "type": "ANSWER",
            "answer": "<answer>",
            "qid": "<qid>"
          }
        }
      }
}'
{
    "lineId": "262e67be-c08c-43c0-bb51-06fe4408b4e9",
    "type": "INTAKE_COMPLETE",
    "payload": {
        "referrer": "referrer",
        "intake": {
          "qid1": {
            "type": "ANSWER",
            "answer": "answer1",
            "qid": "qid1"
          },
          "qid2": {
            "type": "ANSWER",
            "answer": "answer2",
            "qid": "qid12"
          }
        }
    }
}

Event payload fields:

TypeRequiredDescription
lineIdtrueUUID for the associated product
typetrueMust be set to CLIENT_VALIDATION
payloadtrueExplained below

Payload fields

TypeRequiredDescription
referrerfalseOptional String value to track a referral
intaketrueMap of QID to answer

Response payload

{
    "triggerRequestId": "3282bbc7-8113-419c-b53d-9c84c150f3c4",
    "executedActionCount": 1,
    "expectedResponseCount": 0,
    "metadata": {
        "client": "3107a2fc-9a63-4e14-9a83-e4c325f4242b"
    }
}