Události workspace

Událost workspace je událost, kterou váš workspace deklaruje dřív, než ji kdokoli odešle: její název, volitelný zobrazovaný název a vlastnosti, které nese, každou s typem. Události tohoto typu se odesílají jako w:<name> a Emailit odmítne ty, které definici neodpovídají. Tato stránka vysvětluje, jak je definovat a jak funguje validace.

Pokud strukturu deklarovat nechcete, odešlete místo toho vlastní událost (c:<name>). Události workspace i vlastní události jsou součástí tarifů Pro, Business a Custom.

Definujte událost workspace

curl -X POST https://api.emailit.com/v2/workspace/events \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "customer.type",
    "title": "Customer type",
    "properties": [
      { "name": "segment", "type": "string", "required": true },
      { "name": "since", "type": "date" }
    ]
  }'

Pak ji odesílejte jako kteroukoli jinou událost, sledovacím skriptem nebo přes API:

curl -X POST https://api.emailit.com/v2/events \
  -H "Authorization: Bearer $EMAILIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "type": "w:customer.type", "email": "jane@example.com", "properties": { "segment": "b2b", "since": "2026-10-01" } }'

Typy vlastností

Jak se události kontrolují

Když dorazí událost w:, Emailit porovná její properties s definicí:

• Každá vlastnost musí být v definici. Neznámé vlastnosti se odmítnou, takže překlep nezůstane bez povšimnutí.
• Povinné vlastnosti musí být uvedené a nesmí být null.
• Volitelnou vlastnost můžete vynechat, nebo ji poslat jako null, když je prázdná.
• Každá hodnota musí odpovídat svému typu.

Odmítne se i událost w:, jejíž název není definovaný. API odpoví 422 a každý problém uvede pod jeho cestou, například properties.since. Sledovací skript neplatné události zahodí a se zapnutým laděním vypíše do konzole důvod.

Změňte nebo smažte definici

Na kartě Workspace events vyberte u definice Edit, nebo Delete. Přes API použijte endpointy Úprava události workspace a Smazání události workspace.

• Definice kontroluje jen nové události. Už uložené události si ponechají vlastnosti, které měly.
• Změna vlastností nahradí celý seznam. Systémy, které dál posílají odebranou vlastnost, dostanou chyby, proto je aktualizujte předem, nebo současně.
• Přejmenování změní typ, který se má odesílat. Uložené události si ponechají starý typ a nové události se starým názvem se odmítnou.
• Po smazání zůstanou uložené události zachované a nové události tohoto typu se odmítají, dokud ho znovu nedefinujete.

Limity

Workspace může definovat tolik událostí workspace, kolik typů událostí zahrnuje jeho tarif: 100 v tarifu Pro a 1 000 v tarifu Business, v tarifu Custom bez limitu. Definice další události vrátí 422 s code workspace_events_limit. Každá událost workspace má nejvýše 50 vlastností. Názvy mají nejvýše 100 znaků, názvy vlastností nejvýše 64, zobrazované názvy nejvýše 120 a popisy nejvýše 1 000.

Související