POST
/
webevents
curl --request POST \
  --url https://commerce.driv.ly/api/webevents \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "wev_7h9k2j5s3d4f",
  "name": "User Login",
  "account": {
    "id": "acc_0jk3v58djsi1",
    "lead": "Lead ID",
    "consumer": {
      "id": "con_2k4jd93vsd82",
      "ssn": "123-45-6789",
      "email": "example@example.com",
      "lastName": "Doe",
      "birthDate": "1990-05-15",
      "firstName": "John",
      "phoneNumber": "555-0199"
    },
    "anonymousIds": [
      "anon_4598kdjv9390",
      "anon_4598kdjv9391"
    ]
  },
  "anonymousId": "anon_4598kdjv9390"
}'
{
  "data": {
    "id": "wev_7h9k2j5s3d4f",
    "name": "User Login",
    "account": {
      "id": "acc_0jk3v58djsi1",
      "lead": "Lead ID",
      "consumer": {
        "id": "con_2k4jd93vsd82",
        "ssn": "123-45-6789",
        "email": "example@example.com",
        "lastName": "Doe",
        "birthDate": "1990-05-15",
        "firstName": "John",
        "phoneNumber": "555-0199"
      },
      "anonymousIds": [
        "anon_4598kdjv9390",
        "anon_4598kdjv9391"
      ]
    },
    "anonymousId": "anon_4598kdjv9390"
  },
  "success": true
}

Query Parameters

depth
integer

The number of levels of related objects to include in the response

Body

application/json
name
string
required

Web Event has Name

id
string

Web Event is uniquely identified by id

anonymousId
string

Web Event was created by Anonymous ID

account

Web Event was created by Account

Response

200
application/json
Web Event Created
data
object
Example:
{
  "id": "wev_7h9k2j5s3d4f",
  "name": "User Login",
  "account": {
    "id": "acc_0jk3v58djsi1",
    "lead": "Lead ID",
    "consumer": {
      "id": "con_2k4jd93vsd82",
      "ssn": "123-45-6789",
      "email": "example@example.com",
      "lastName": "Doe",
      "birthDate": "1990-05-15",
      "firstName": "John",
      "phoneNumber": "555-0199"
    },
    "anonymousIds": ["anon_4598kdjv9390", "anon_4598kdjv9391"]
  },
  "anonymousId": "anon_4598kdjv9390"
}
success
boolean