API Reference

Zaraz

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Config

Get Zaraz configuration

client.Zaraz.Config.Get(ctx, query) (*Configuration, error)

GET/zones/{zone_id}/settings/zaraz/config

Update Zaraz configuration

client.Zaraz.Config.Update(ctx, params) (*Configuration, error)

PUT/zones/{zone_id}/settings/zaraz/config

ModelsExpand Collapse

type Configuration struct{…}

Zaraz configuration.

DataLayer bool

Data layer compatibility mode enabled.

DebugKey string

The key for Zaraz debug mode.

Settings ConfigurationSettings

General Zaraz settings.

AutoInjectScript bool

Automatic injection of Zaraz scripts enabled.

ContextEnricher ConfigurationSettingsContextEnricheroptional

Details of the worker that receives and edits Zaraz Context object.

EscapedWorkerName string

WorkerTag string

CookieDomain stringoptional

The domain Zaraz will use for writing and reading its cookies.

Ecommerce booloptional

Ecommerce API enabled.

EventsAPIPath stringoptional

Custom endpoint for server-side track events.

HideExternalReferer booloptional

Hiding external referrer URL enabled.

HideIPAddress booloptional

Trimming IP address enabled.

HideQueryParams booloptional

Removing URL query params enabled.

HideUserAgent booloptional

Removing sensitive data from User Agent string enabled.

InitPath stringoptional

Custom endpoint for Zaraz init script.

InjectIframes booloptional

Injection of Zaraz scripts into iframes enabled.

McRootPath stringoptional

Custom path for Managed Components server functionalities.

ScriptPath stringoptional

Custom endpoint for Zaraz main script.

TrackPath stringoptional

Custom endpoint for Zaraz tracking requests.

Tools map[string, ConfigurationTool]

Tools set up under Zaraz configuration, where key is the alpha-numeric tool ID and value is the tool configuration object.

One of the following:

type ConfigurationToolsZarazManagedComponent struct{…}

BlockingTriggers []string

List of blocking trigger IDs.

Component string

Tool's internal name.

DefaultFields map[string, ConfigurationToolsZarazManagedComponentDefaultFieldsUnion]

Default fields for tool's actions.

One of the following:

UnionString

UnionBool

Enabled bool

Whether tool is enabled.

Name string

Tool's name defined by the user.

Permissions []string

List of permissions granted to the component.

Settings map[string, ConfigurationToolsZarazManagedComponentSettingsUnion]

Tool's settings.

One of the following:

UnionString

UnionBool

Type ConfigurationToolsZarazManagedComponentType

Actions map[string, NeoEvent]optional

Actions configured on a tool. Either this or neoEvents field is required.

ActionType string

Tool event type.

BlockingTriggers []string

List of blocking triggers IDs.

Data unknown

Event payload.

FiringTriggers []string

List of firing triggers IDs.

DefaultPurpose stringoptional

Default consent purpose ID.

NeoEvents []NeoEventoptional

DEPRECATED - List of actions configured on a tool. Either this or actions field is required. If both are present, actions field will take precedence.

ActionType string

Tool event type.

BlockingTriggers []string

List of blocking triggers IDs.

Data unknown

Event payload.

FiringTriggers []string

List of firing triggers IDs.

VendorName stringoptional

Vendor name for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned.

VendorPolicyURL stringoptional

Vendor's Privacy Policy URL for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned.

type ConfigurationToolsWorker struct{…}

BlockingTriggers []string

List of blocking trigger IDs.

Component string

Tool's internal name.

DefaultFields map[string, ConfigurationToolsWorkerDefaultFieldsUnion]

Default fields for tool's actions.

One of the following:

UnionString

UnionBool

Enabled bool

Whether tool is enabled.

Name string

Tool's name defined by the user.

Permissions []string

List of permissions granted to the component.

Settings map[string, ConfigurationToolsWorkerSettingsUnion]

Tool's settings.

One of the following:

UnionString

UnionBool

Type ConfigurationToolsWorkerType

Worker ConfigurationToolsWorkerWorker

Cloudflare worker that acts as a managed component.

EscapedWorkerName string

WorkerTag string

Actions map[string, NeoEvent]optional

Actions configured on a tool. Either this or neoEvents field is required.

ActionType string

Tool event type.

BlockingTriggers []string

List of blocking triggers IDs.

Data unknown

Event payload.

FiringTriggers []string

List of firing triggers IDs.

DefaultPurpose stringoptional

Default consent purpose ID.

NeoEvents []NeoEventoptional

DEPRECATED - List of actions configured on a tool. Either this or actions field is required. If both are present, actions field will take precedence.

ActionType string

Tool event type.

BlockingTriggers []string

List of blocking triggers IDs.

Data unknown

Event payload.

FiringTriggers []string

List of firing triggers IDs.

VendorName stringoptional

Vendor name for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned.

VendorPolicyURL stringoptional

Vendor's Privacy Policy URL for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned.

Triggers map[string, ConfigurationTrigger]

Triggers set up under Zaraz configuration, where key is the trigger alpha-numeric ID and value is the trigger configuration.

ExcludeRules []ConfigurationTriggersExcludeRule

Rules defining when the trigger is not fired.

One of the following:

type ConfigurationTriggersExcludeRulesZarazLoadRule struct{…}

ID string

Match string

Op ConfigurationTriggersExcludeRulesZarazLoadRuleOp

One of the following:

const ConfigurationTriggersExcludeRulesZarazLoadRuleOpContains ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "CONTAINS"

const ConfigurationTriggersExcludeRulesZarazLoadRuleOpEquals ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "EQUALS"

const ConfigurationTriggersExcludeRulesZarazLoadRuleOpStartsWith ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "STARTS_WITH"

const ConfigurationTriggersExcludeRulesZarazLoadRuleOpEndsWith ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "ENDS_WITH"

const ConfigurationTriggersExcludeRulesZarazLoadRuleOpMatchRegex ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "MATCH_REGEX"

const ConfigurationTriggersExcludeRulesZarazLoadRuleOpNotMatchRegex ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "NOT_MATCH_REGEX"

const ConfigurationTriggersExcludeRulesZarazLoadRuleOpGreaterThan ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "GREATER_THAN"

const ConfigurationTriggersExcludeRulesZarazLoadRuleOpGreaterThanOrEqual ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "GREATER_THAN_OR_EQUAL"

const ConfigurationTriggersExcludeRulesZarazLoadRuleOpLessThan ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "LESS_THAN"

const ConfigurationTriggersExcludeRulesZarazLoadRuleOpLessThanOrEqual ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "LESS_THAN_OR_EQUAL"

Value string

type ConfigurationTriggersExcludeRulesZarazClickListenerRule struct{…}

ID string

Action ConfigurationTriggersExcludeRulesZarazClickListenerRuleAction

Settings ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettings

Selector string

Type ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettingsType

One of the following:

const ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettingsTypeXpath ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettingsType = "xpath"

const ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettingsTypeCSS ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettingsType = "css"

WaitForTags int64

minimum0

type ConfigurationTriggersExcludeRulesZarazTimerRule struct{…}

ID string

Action ConfigurationTriggersExcludeRulesZarazTimerRuleAction

Settings ConfigurationTriggersExcludeRulesZarazTimerRuleSettings

Interval int64

minimum50

Limit int64

minimum0

type ConfigurationTriggersExcludeRulesZarazFormSubmissionRule struct{…}

ID string

Action ConfigurationTriggersExcludeRulesZarazFormSubmissionRuleAction

Settings ConfigurationTriggersExcludeRulesZarazFormSubmissionRuleSettings

Selector string

Validate bool

type ConfigurationTriggersExcludeRulesZarazVariableMatchRule struct{…}

ID string

Action ConfigurationTriggersExcludeRulesZarazVariableMatchRuleAction

Settings ConfigurationTriggersExcludeRulesZarazVariableMatchRuleSettings

Match string

Variable string

type ConfigurationTriggersExcludeRulesZarazScrollDepthRule struct{…}

ID string

Action ConfigurationTriggersExcludeRulesZarazScrollDepthRuleAction

Settings ConfigurationTriggersExcludeRulesZarazScrollDepthRuleSettings

Positions string

type ConfigurationTriggersExcludeRulesZarazElementVisibilityRule struct{…}

ID string

Action ConfigurationTriggersExcludeRulesZarazElementVisibilityRuleAction

Settings ConfigurationTriggersExcludeRulesZarazElementVisibilityRuleSettings

Selector string

LoadRules []ConfigurationTriggersLoadRule

Rules defining when the trigger is fired.

One of the following:

type ConfigurationTriggersLoadRulesZarazLoadRule struct{…}

ID string

Match string

Op ConfigurationTriggersLoadRulesZarazLoadRuleOp

One of the following:

const ConfigurationTriggersLoadRulesZarazLoadRuleOpContains ConfigurationTriggersLoadRulesZarazLoadRuleOp = "CONTAINS"

const ConfigurationTriggersLoadRulesZarazLoadRuleOpEquals ConfigurationTriggersLoadRulesZarazLoadRuleOp = "EQUALS"

const ConfigurationTriggersLoadRulesZarazLoadRuleOpStartsWith ConfigurationTriggersLoadRulesZarazLoadRuleOp = "STARTS_WITH"

const ConfigurationTriggersLoadRulesZarazLoadRuleOpEndsWith ConfigurationTriggersLoadRulesZarazLoadRuleOp = "ENDS_WITH"

const ConfigurationTriggersLoadRulesZarazLoadRuleOpMatchRegex ConfigurationTriggersLoadRulesZarazLoadRuleOp = "MATCH_REGEX"

const ConfigurationTriggersLoadRulesZarazLoadRuleOpNotMatchRegex ConfigurationTriggersLoadRulesZarazLoadRuleOp = "NOT_MATCH_REGEX"

const ConfigurationTriggersLoadRulesZarazLoadRuleOpGreaterThan ConfigurationTriggersLoadRulesZarazLoadRuleOp = "GREATER_THAN"

const ConfigurationTriggersLoadRulesZarazLoadRuleOpGreaterThanOrEqual ConfigurationTriggersLoadRulesZarazLoadRuleOp = "GREATER_THAN_OR_EQUAL"

const ConfigurationTriggersLoadRulesZarazLoadRuleOpLessThan ConfigurationTriggersLoadRulesZarazLoadRuleOp = "LESS_THAN"

const ConfigurationTriggersLoadRulesZarazLoadRuleOpLessThanOrEqual ConfigurationTriggersLoadRulesZarazLoadRuleOp = "LESS_THAN_OR_EQUAL"

Value string

type ConfigurationTriggersLoadRulesZarazClickListenerRule struct{…}

ID string

Action ConfigurationTriggersLoadRulesZarazClickListenerRuleAction

Settings ConfigurationTriggersLoadRulesZarazClickListenerRuleSettings

Selector string

Type ConfigurationTriggersLoadRulesZarazClickListenerRuleSettingsType

One of the following:

const ConfigurationTriggersLoadRulesZarazClickListenerRuleSettingsTypeXpath ConfigurationTriggersLoadRulesZarazClickListenerRuleSettingsType = "xpath"

const ConfigurationTriggersLoadRulesZarazClickListenerRuleSettingsTypeCSS ConfigurationTriggersLoadRulesZarazClickListenerRuleSettingsType = "css"

WaitForTags int64

minimum0

type ConfigurationTriggersLoadRulesZarazTimerRule struct{…}

ID string

Action ConfigurationTriggersLoadRulesZarazTimerRuleAction

Settings ConfigurationTriggersLoadRulesZarazTimerRuleSettings

Interval int64

minimum50

Limit int64

minimum0

type ConfigurationTriggersLoadRulesZarazFormSubmissionRule struct{…}

ID string

Action ConfigurationTriggersLoadRulesZarazFormSubmissionRuleAction

Settings ConfigurationTriggersLoadRulesZarazFormSubmissionRuleSettings

Selector string

Validate bool

type ConfigurationTriggersLoadRulesZarazVariableMatchRule struct{…}

ID string

Action ConfigurationTriggersLoadRulesZarazVariableMatchRuleAction

Settings ConfigurationTriggersLoadRulesZarazVariableMatchRuleSettings

Match string

Variable string

type ConfigurationTriggersLoadRulesZarazScrollDepthRule struct{…}

ID string

Action ConfigurationTriggersLoadRulesZarazScrollDepthRuleAction

Settings ConfigurationTriggersLoadRulesZarazScrollDepthRuleSettings

Positions string

type ConfigurationTriggersLoadRulesZarazElementVisibilityRule struct{…}

ID string

Action ConfigurationTriggersLoadRulesZarazElementVisibilityRuleAction

Settings ConfigurationTriggersLoadRulesZarazElementVisibilityRuleSettings

Selector string

Name string

Trigger name.

Description stringoptional

Trigger description.

System ConfigurationTriggersSystemoptional

Variables map[string, ConfigurationVariable]

Variables set up under Zaraz configuration, where key is the variable alpha-numeric ID and value is the variable configuration. Values of variables of type secret are not included.

One of the following:

type ConfigurationVariablesZarazStringVariable struct{…}

Name string

Type ConfigurationVariablesZarazStringVariableType

Value string

type ConfigurationVariablesZarazSecretVariable struct{…}

Name string

Type ConfigurationVariablesZarazSecretVariableType

Value string

type ConfigurationVariablesZarazWorkerVariable struct{…}

Name string

Type ConfigurationVariablesZarazWorkerVariableType

Value ConfigurationVariablesZarazWorkerVariableValue

EscapedWorkerName string

WorkerTag string

ZarazVersion int64

Zaraz internal version of the config.

Analytics ConfigurationAnalyticsoptional

Cloudflare Monitoring settings.

DefaultPurpose stringoptional

Consent purpose assigned to Monitoring.

Enabled booloptional

Whether Advanced Monitoring reports are enabled.

SessionExpTime int64optional

Session expiration time (seconds).

maximum86400

minimum60

Consent ConfigurationConsentoptional

Consent management configuration.

Enabled bool

ButtonTextTranslations ButtonTextTranslationoptional

CompanyEmail stringoptional

CompanyName stringoptional

CompanyStreetAddress stringoptional

ConsentModalIntroHTML stringoptional

ConsentModalIntroHTMLWithTranslations map[string, string]optional

Object where keys are language codes.

CookieName stringoptional

CustomCSS stringoptional

CustomIntroDisclaimerDismissed booloptional

DefaultLanguage stringoptional

HideModal booloptional

Purposes map[string, ConfigurationConsentPurpose]optional

Object where keys are purpose alpha-numeric IDs.

Description string

Name string

PurposesWithTranslations map[string, ConfigurationConsentPurposesWithTranslation]optional

Object where keys are purpose alpha-numeric IDs.

Description map[string, string]

Object where keys are language codes.

Name map[string, string]

Object where keys are language codes.

Order int64

TcfCompliant booloptional

HistoryChange booloptional

Single Page Application support enabled.