SiteEventBatchRequest

events object[]required

Possible values: >= 1, <= 100

Array [

idstringrequired

O id do evento no site — um UUID gerado quando ele aconteceu. É por ele que um reenvio é reconhecido como duplicado; o mesmo id duas vezes no lote é um evento só.

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

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

namestringrequired

<origem>.<objeto>.<acontecimento>. Os eventos da sua própria integração vão em 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

Quando aconteceu, em ISO 8601 com fuso.

schema_versioninteger

A versão do formato de data desse evento.

Possible values: >= 1 and <= 100

Default value: 1

site_urlstring

O endereço do site (home_url() no WordPress). Quando vem, precisa ser o mesmo em que o site foi conectado.

Possible values: <= 500 characters

Example: https://loja.example.com

contact objectnullable

A pessoa de quem o evento fala. Sem ela, nenhum fluxo começa.

ref objectrequired

Quem a pessoa é no site — o vínculo que acha o mesmo contato mesmo depois de uma troca de número.

kindstringrequired

wp_user: usuário do WordPress. wc_customer: cliente do WooCommerce. wc_guest: compra sem conta. lead: alguém conhecido só por um formulário ou um carrinho.

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

idstringrequired

O id da pessoa no site. Quem não tem conta (wc_guest, lead) vai pelo sha256 do 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

O consentimento que a pessoa deu ou retirou no site. Um opt-out sempre vale; um opt-in só passa um contato de unknown para opted_in, nunca por cima de um opt-out ou de uma supressão.

oneOf

• Opt-in
• Opt-out

statusstringrequired

Possible values: [opted_in]

evidencestringrequired

O que a pessoa aceitou e onde: o texto da caixa marcada, o pedido, o site.

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

atstring<date-time>

Quando a pessoa aceitou.

data object

O que aconteceu, no formato que o site quiser. No fluxo, fica em {{trigger.<caminho>}}.

property name*any

O que aconteceu, no formato que o site quiser. No fluxo, fica em {{trigger.<caminho>}}.

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://loja.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": {}
    }
  ]
}