Skip to main content

Activity

activity_idstring<uuid>required

Idempotency key. Replaying the same id is a no-op.

activitystringrequired

Name in the activity catalogue, e.g. issued_ticket or custom.joined_waitlist.

tsstring<date-time>required

When it happened.

owner_refstring

The owner, as : with type evx, wzt, lei or own. Required with a group or platform key; with a single-owner key it is optional and must match the key's owner.

Example: evx:ee69a000-d48d-11ec-8515-8b933281c556
owner object

Lets a trusted platform key register an owner on first mention.

namestring
countrystring

ISO 3166-1 alpha-2

identifiers object[]
  • Array [
    • typestringrequired

    Possible values: [email, phone, device, barcode, chip, external]

    valuestringrequired

    As the person gave it; normalised on arrival.

    rolestring
    Example: buyer
    namespacestring

    Issuing system of a barcode or provider of a chip.

    confidenceinteger

    Possible values: >= 0 and <= 100

    Default value: 100
  • ]
    • anonymous_customer_idstring
    Example: evx_web_8f21c0
    revenue object

    Only on revenue-bearing activities, and never from a browser key.

    amountstringrequired

    Decimal string with at most 4 places, never a number.

    Example: 109.00
    currencystringrequired

    ISO 4217

    Example: EUR
    features object

    The activity's own fields, checked against its schema.

    property name*any

    The activity's own fields, checked against its schema.

    linkstring

    Deep link to the supplier record.

    geo object[]

    Where the people on the activity live or were. Each block is turned into a place beside the stream and is never stored as sent: an address becomes lookup keys, an IP its city, a position fix a cell of about a kilometre; the position of an action (where the activity happened) is kept exactly. Platform and server keys only; a block from a browser key is dropped.

  • Array [
    • kindstringrequired

    home: an address as typed; ip: where the person connected from; device: a position fix, coarsened to a cell; action: where the activity happened (a gate, a bar), kept exactly.

    Possible values: [home, ip, device, action]

    rolestring

    The identifier the block is about, e.g. buyer or holder; the first one otherwise.

    Example: buyer
    citystring
    postal_codestring
    countrystring

    A name or an ISO 3166-1 code.

    localestring

    The sender's locale for the person (nl_NL, de-DE): a hint for the country, after the answer, the postal code's shape and the ip block.

    Example: nl_NL
    ipstring

    Looked up once and dropped.

    latnumber

    Possible values: >= -90 and <= 90

    lonnumber

    Possible values: >= -180 and <= 180

  • ]
    • Activity
    {
      "activity_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "activity": "string",
      "ts": "2024-07-29T15:51:28.071Z",
      "owner_ref": "evx:ee69a000-d48d-11ec-8515-8b933281c556",
      "owner": {
        "name": "string",
        "country": "string"
      },
      "identifiers": [
        {
          "type": "email",
          "value": "string",
          "role": "buyer",
          "namespace": "string",
          "confidence": 100
        }
      ],
      "anonymous_customer_id": "evx_web_8f21c0",
      "revenue": {
        "amount": "109.00",
        "currency": "EUR"
      },
      "features": {},
      "link": "string",
      "geo": [
        {
          "kind": "home",
          "role": "buyer",
          "city": "string",
          "postal_code": "string",
          "country": "string",
          "locale": "nl_NL",
          "ip": "string",
          "lat": 0,
          "lon": 0
        }
      ]
    }