Zaraz

zaraz

Methods

Update Zaraz Workflow -> Envelope<>
put/zones/{zone_id}/settings/zaraz/workflow

Updates Zaraz workflow for a zone.

Domain types

ButtonTextTranslation = { accept_all, confirm_my_choices, reject_all }
NeoEvent = { actionType, blockingTriggers, data, 1 more... }
Zaraz

Config

zaraz.config

Methods

Get Zaraz Configuration -> Envelope<>
get/zones/{zone_id}/settings/zaraz/config

Gets latest Zaraz configuration for a zone. It can be preview or published configuration, whichever was the last updated. Secret variables values will not be included.

Update Zaraz Configuration -> Envelope<>
put/zones/{zone_id}/settings/zaraz/config

Updates Zaraz configuration for a zone.

Domain types

Configuration = { dataLayer, debugKey, settings, 7 more... }

Zaraz configuration

Zaraz

Default

zaraz.default

Methods

Get Default Zaraz Configuration -> Envelope<>
get/zones/{zone_id}/settings/zaraz/default

Gets default Zaraz configuration for a zone.

Zaraz

Export

zaraz.export

Methods

Export Zaraz Configuration ->
get/zones/{zone_id}/settings/zaraz/export

Exports full current published Zaraz configuration for a zone, secret variables included.

Zaraz

History

zaraz.history

Methods

List Zaraz Historical Configuration Records -> SinglePage<{ id, createdAt, description, 2 more... }>
get/zones/{zone_id}/settings/zaraz/history

Lists a history of published Zaraz configuration records for a zone.

Restore Zaraz Historical Configuration By ID -> Envelope<>
put/zones/{zone_id}/settings/zaraz/history

Restores a historical published Zaraz configuration by ID for a zone.

zaraz.history.configs

Methods

Get Zaraz Historical Configurations By ID S -> Envelope<Record<string, { id, config, createdAt, 2 more... }>>
get/zones/{zone_id}/settings/zaraz/history/configs

Gets a history of published Zaraz configurations by ID(s) for a zone.

Zaraz

Publish

zaraz.publish

Methods

Publish Zaraz Preview Configuration -> Envelope<string>
post/zones/{zone_id}/settings/zaraz/publish

Publish current Zaraz preview configuration for a zone.

Zaraz

Workflow

zaraz.workflow

Methods

Get Zaraz Workflow -> Envelope<>
get/zones/{zone_id}/settings/zaraz/workflow

Gets Zaraz workflow for a zone.

Domain types

Workflow = "realtime" | "preview"

Zaraz workflow