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 after a client's information has been entered;
Storefront: fires after a user finishes entering their information;
API: can fire this event externally 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"
          }
        }
    }
}

Request fields

Type	Required	Description
`lineId`	`true`	UUID for the associated product
`type`	`true`	Must be set to `CLIENT_VALIDATION`
`payload`	`true`	Explained below

Payload fields

Type	Required	Description
`referrer`	`false`	Optional String value to track a referral
`intake`	`true`	Map of QID to answer

Response json

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

Response fields

Property	Required	Description
`triggerRequestId`	`true`	UUID that identifies the execution of the trigger.
`executedActionCount`	`true`	Number of actions executed by this trigger.
`expectedResponseCount`	`true`	Number of responses expected from the executed actions (may be `0`).
`metadata`	`false`	Additional details produced by the triggered actions.

Metadata fields

In this case, the metadata contains a single entry that maps to a client identifier.

Property	Required	Description
`client`	`false`	UUID of the client associated with the triggered action.