Saltar al contenido principal

SiteEventBatchRequest

events object[]required

Possible values: >= 1, <= 100

  • Array [
  • idstringrequired

    El id del evento en el sitio — un UUID generado cuando ocurrió. Es lo que hace que un reenvío cuente como duplicado; el mismo id dos veces en el lote es un solo evento.

    Possible values: Value must match regular expression ^[A-Za-z0-9_.:-]{8,64}$

    Example: 9b2f6c1e-4d7a-4f0e-9a51-2f8c3d6e7a10
    namestringrequired

    <origen>.<objeto>.<suceso>. Los eventos de tu propia integración van en custom..

    Possible values: <= 80 characters, Value must match regular expression ^(wp|wc|wcs|form|fcrc|custom)(\.[a-z0-9_]+){1,3}$

    Example: wc.order.paid
    occurred_atstring<date-time>required

    Cuándo ocurrió, en ISO 8601 con zona horaria.

    schema_versioninteger

    La versión del formato de data de ese evento.

    Possible values: >= 1 and <= 100

    Default value: 1
    site_urlstring

    La dirección del sitio (home_url() en WordPress). Cuando viene, debe ser la misma en que se conectó el sitio.

    Possible values: <= 500 characters

    Example: https://tienda.example.com
    contact objectnullable

    La persona de la que habla el evento. Sin ella, no empieza ningún flujo.

    ref objectrequired

    Quién es la persona en el sitio — el vínculo que encuentra al mismo contacto incluso después de un cambio de número.

    kindstringrequired

    wp_user: usuario de WordPress. wc_customer: cliente de WooCommerce. wc_guest: compra sin cuenta. lead: alguien conocido solo por un formulario o un carrito.

    Possible values: [wp_user, wc_customer, wc_guest, lead]

    idstringrequired

    El id de la persona en el sitio. Quien no tiene cuenta (wc_guest, lead) va por el sha256 de su e-mail.

    Possible values: non-empty and <= 191 characters

    Example: 42
    phonestringnullable

    Possible values: <= 40 characters

    countrystringnullable

    Possible values: >= 2 characters and <= 2 characters

    first_namestringnullable

    Possible values: <= 80 characters

    last_namestringnullable

    Possible values: <= 80 characters

    emailstringnullable

    Possible values: <= 254 characters

    localestringnullable

    Possible values: Value must match regular expression ^[a-z]{2}(-[A-Z]{2})?$

    attributes object
    property name*any
    tagsstring[]

    Possible values: <= 20

    remove_tagsstring[]

    Possible values: <= 20

    consent object

    El consentimiento que la persona dio o retiró en el sitio. Una baja siempre vale; un opt-in solo pasa un contacto de unknown a opted_in, nunca por encima de una baja o de una supresión.

    oneOf
    statusstringrequired

    Possible values: [opted_in]

    evidencestringrequired

    Qué aceptó la persona y dónde: el texto de la casilla marcada, el pedido, el sitio.

    Possible values: >= 3 characters and <= 500 characters

    atstring<date-time>

    Cuándo aceptó la persona.

    data object

    Lo que pasó, en el formato que el sitio quiera. En el flujo, queda en {{trigger.<ruta>}}.

    property name*any

    Lo que pasó, en el formato que el sitio quiera. En el flujo, queda en {{trigger.<ruta>}}.

    Default value: {}
  • ]
  • SiteEventBatchRequest
    {
    "events": [
    {
    "id": "9b2f6c1e-4d7a-4f0e-9a51-2f8c3d6e7a10",
    "name": "wc.order.paid",
    "occurred_at": "2024-07-29T15:51:28.071Z",
    "schema_version": 1,
    "site_url": "https://tienda.example.com",
    "contact": {
    "ref": {
    "kind": "wp_user",
    "id": "42"
    },
    "phone": "string",
    "country": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "locale": "string",
    "attributes": {},
    "tags": [
    "string"
    ],
    "remove_tags": [
    "string"
    ],
    "consent": {
    "status": "opted_in",
    "evidence": "string",
    "at": "2024-07-29T15:51:28.071Z"
    }
    },
    "data": {}
    }
    ]
    }