--- title: Zaraz --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Zaraz ##### [Update Zaraz workflow](https://developers.cloudflare.com/api/go/resources/zaraz/methods/update) client.Zaraz.Update(ctx, params) (\*[Workflow](), error) PUT/zones/{zone\_id}/settings/zaraz/workflow ##### ModelsExpand Collapse
type ButtonTextTranslation struct{…} AcceptAll map\[string, string] Object where keys are language codes. Link to this property ConfirmMyChoices map\[string, string] Object where keys are language codes. Link to this property RejectAll map\[string, string] Object where keys are language codes. Link to this property
[Link to this property](<#(resource)%20zaraz%20%3E%20(model)%20button_text_translation%20%3E%20(schema)>)
type NeoEvent struct{…} ActionType string Tool event type. Link to this property BlockingTriggers \[]string List of blocking triggers IDs. Link to this property Data unknown Event payload. Link to this property FiringTriggers \[]string List of firing triggers IDs. Link to this property
[Link to this property](<#(resource)%20zaraz%20%3E%20(model)%20neo_event%20%3E%20(schema)>) #### ZarazConfig ##### [Get Zaraz configuration](https://developers.cloudflare.com/api/go/resources/zaraz/subresources/config/methods/get) client.Zaraz.Config.Get(ctx, query) (\*[Configuration](), error) GET/zones/{zone\_id}/settings/zaraz/config ##### [Update Zaraz configuration](https://developers.cloudflare.com/api/go/resources/zaraz/subresources/config/methods/update) 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. Link to this property DebugKey string The key for Zaraz debug mode. Link to this property
Settings ConfigurationSettings General Zaraz settings. AutoInjectScript bool Automatic injection of Zaraz scripts enabled. Link to this property
ContextEnricher ConfigurationSettingsContextEnricherOptional Details of the worker that receives and edits Zaraz Context object. EscapedWorkerName string Link to this property WorkerTag string Link to this property
Link to this property CookieDomain stringOptional The domain Zaraz will use for writing and reading its cookies. Link to this property Ecommerce boolOptional Ecommerce API enabled. Link to this property EventsAPIPath stringOptional Custom endpoint for server-side track events. Link to this property HideExternalReferer boolOptional Hiding external referrer URL enabled. Link to this property HideIPAddress boolOptional Trimming IP address enabled. Link to this property HideQueryParams boolOptional Removing URL query params enabled. Link to this property HideUserAgent boolOptional Removing sensitive data from User Agent string enabled. Link to this property InitPath stringOptional Custom endpoint for Zaraz init script. Link to this property InjectIframes boolOptional Injection of Zaraz scripts into iframes enabled. Link to this property McRootPath stringOptional Custom path for Managed Components server functionalities. Link to this property ScriptPath stringOptional Custom endpoint for Zaraz main script. Link to this property TrackPath stringOptional Custom endpoint for Zaraz tracking requests. Link to this property
Link to this property
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. Link to this property Component string Tool’s internal name. Link to this property
DefaultFields map\[string, ConfigurationToolsZarazManagedComponentDefaultFieldsUnion] Default fields for tool’s actions. One of the following: UnionString Link to this property UnionBool Link to this property
Link to this property Enabled bool Whether tool is enabled. Link to this property Name string Tool’s name defined by the user. Link to this property Permissions \[]string List of permissions granted to the component. Link to this property
Settings map\[string, ConfigurationToolsZarazManagedComponentSettingsUnion] Tool’s settings. One of the following: UnionString Link to this property UnionBool Link to this property
Link to this property Type ConfigurationToolsZarazManagedComponentType Link to this property
Actions map\[string, NeoEvent]Optional Actions configured on a tool. Either this or neoEvents field is required. ActionType string Tool event type. Link to this property BlockingTriggers \[]string List of blocking triggers IDs. Link to this property Data unknown Event payload. Link to this property FiringTriggers \[]string List of firing triggers IDs. Link to this property
Link to this property DefaultPurpose stringOptional Default consent purpose ID. Link to this property
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. Link to this property BlockingTriggers \[]string List of blocking triggers IDs. Link to this property Data unknown Event payload. Link to this property FiringTriggers \[]string List of firing triggers IDs. Link to this property
Link to this property VendorName stringOptional Vendor name for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned. Link to this property 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. Link to this property
Link to this property
type ConfigurationToolsWorker struct{…} BlockingTriggers \[]string List of blocking trigger IDs. Link to this property Component string Tool’s internal name. Link to this property
DefaultFields map\[string, ConfigurationToolsWorkerDefaultFieldsUnion] Default fields for tool’s actions. One of the following: UnionString Link to this property UnionBool Link to this property
Link to this property Enabled bool Whether tool is enabled. Link to this property Name string Tool’s name defined by the user. Link to this property Permissions \[]string List of permissions granted to the component. Link to this property
Settings map\[string, ConfigurationToolsWorkerSettingsUnion] Tool’s settings. One of the following: UnionString Link to this property UnionBool Link to this property
Link to this property Type ConfigurationToolsWorkerType Link to this property
Worker ConfigurationToolsWorkerWorker Cloudflare worker that acts as a managed component. EscapedWorkerName string Link to this property WorkerTag string Link to this property
Link to this property
Actions map\[string, NeoEvent]Optional Actions configured on a tool. Either this or neoEvents field is required. ActionType string Tool event type. Link to this property BlockingTriggers \[]string List of blocking triggers IDs. Link to this property Data unknown Event payload. Link to this property FiringTriggers \[]string List of firing triggers IDs. Link to this property
Link to this property DefaultPurpose stringOptional Default consent purpose ID. Link to this property
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. Link to this property BlockingTriggers \[]string List of blocking triggers IDs. Link to this property Data unknown Event payload. Link to this property FiringTriggers \[]string List of firing triggers IDs. Link to this property
Link to this property VendorName stringOptional Vendor name for TCF compliant consent modal, required for Custom Managed Components and Custom HTML tool with a defaultPurpose assigned. Link to this property 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. Link to this property
Link to this property
Link to this property
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 Link to this property Match string Link to this property
Op ConfigurationTriggersExcludeRulesZarazLoadRuleOp One of the following: const ConfigurationTriggersExcludeRulesZarazLoadRuleOpContains ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "CONTAINS" Link to this property const ConfigurationTriggersExcludeRulesZarazLoadRuleOpEquals ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "EQUALS" Link to this property const ConfigurationTriggersExcludeRulesZarazLoadRuleOpStartsWith ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "STARTS\_WITH" Link to this property const ConfigurationTriggersExcludeRulesZarazLoadRuleOpEndsWith ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "ENDS\_WITH" Link to this property const ConfigurationTriggersExcludeRulesZarazLoadRuleOpMatchRegex ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "MATCH\_REGEX" Link to this property const ConfigurationTriggersExcludeRulesZarazLoadRuleOpNotMatchRegex ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "NOT\_MATCH\_REGEX" Link to this property const ConfigurationTriggersExcludeRulesZarazLoadRuleOpGreaterThan ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "GREATER\_THAN" Link to this property const ConfigurationTriggersExcludeRulesZarazLoadRuleOpGreaterThanOrEqual ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "GREATER\_THAN\_OR\_EQUAL" Link to this property const ConfigurationTriggersExcludeRulesZarazLoadRuleOpLessThan ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "LESS\_THAN" Link to this property const ConfigurationTriggersExcludeRulesZarazLoadRuleOpLessThanOrEqual ConfigurationTriggersExcludeRulesZarazLoadRuleOp = "LESS\_THAN\_OR\_EQUAL" Link to this property
Link to this property Value string Link to this property
Link to this property
type ConfigurationTriggersExcludeRulesZarazClickListenerRule struct{…} ID string Link to this property Action ConfigurationTriggersExcludeRulesZarazClickListenerRuleAction Link to this property
Settings ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettings Selector string Link to this property
Type ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettingsType One of the following: const ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettingsTypeXpath ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettingsType = "xpath" Link to this property const ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettingsTypeCSS ConfigurationTriggersExcludeRulesZarazClickListenerRuleSettingsType = "css" Link to this property
Link to this property WaitForTags int64 minimum0 Link to this property
Link to this property
Link to this property
type ConfigurationTriggersExcludeRulesZarazTimerRule struct{…} ID string Link to this property Action ConfigurationTriggersExcludeRulesZarazTimerRuleAction Link to this property
Settings ConfigurationTriggersExcludeRulesZarazTimerRuleSettings Interval int64 minimum50 Link to this property Limit int64 minimum0 Link to this property
Link to this property
Link to this property
type ConfigurationTriggersExcludeRulesZarazFormSubmissionRule struct{…} ID string Link to this property Action ConfigurationTriggersExcludeRulesZarazFormSubmissionRuleAction Link to this property
Settings ConfigurationTriggersExcludeRulesZarazFormSubmissionRuleSettings Selector string Link to this property Validate bool Link to this property
Link to this property
Link to this property
type ConfigurationTriggersExcludeRulesZarazVariableMatchRule struct{…} ID string Link to this property Action ConfigurationTriggersExcludeRulesZarazVariableMatchRuleAction Link to this property
Settings ConfigurationTriggersExcludeRulesZarazVariableMatchRuleSettings Match string Link to this property Variable string Link to this property
Link to this property
Link to this property
type ConfigurationTriggersExcludeRulesZarazScrollDepthRule struct{…} ID string Link to this property Action ConfigurationTriggersExcludeRulesZarazScrollDepthRuleAction Link to this property
Settings ConfigurationTriggersExcludeRulesZarazScrollDepthRuleSettings Positions string Link to this property
Link to this property
Link to this property
type ConfigurationTriggersExcludeRulesZarazElementVisibilityRule struct{…} ID string Link to this property Action ConfigurationTriggersExcludeRulesZarazElementVisibilityRuleAction Link to this property
Settings ConfigurationTriggersExcludeRulesZarazElementVisibilityRuleSettings Selector string Link to this property
Link to this property
Link to this property
Link to this property
LoadRules \[]ConfigurationTriggersLoadRule Rules defining when the trigger is fired. One of the following:
type ConfigurationTriggersLoadRulesZarazLoadRule struct{…} ID string Link to this property Match string Link to this property
Op ConfigurationTriggersLoadRulesZarazLoadRuleOp One of the following: const ConfigurationTriggersLoadRulesZarazLoadRuleOpContains ConfigurationTriggersLoadRulesZarazLoadRuleOp = "CONTAINS" Link to this property const ConfigurationTriggersLoadRulesZarazLoadRuleOpEquals ConfigurationTriggersLoadRulesZarazLoadRuleOp = "EQUALS" Link to this property const ConfigurationTriggersLoadRulesZarazLoadRuleOpStartsWith ConfigurationTriggersLoadRulesZarazLoadRuleOp = "STARTS\_WITH" Link to this property const ConfigurationTriggersLoadRulesZarazLoadRuleOpEndsWith ConfigurationTriggersLoadRulesZarazLoadRuleOp = "ENDS\_WITH" Link to this property const ConfigurationTriggersLoadRulesZarazLoadRuleOpMatchRegex ConfigurationTriggersLoadRulesZarazLoadRuleOp = "MATCH\_REGEX" Link to this property const ConfigurationTriggersLoadRulesZarazLoadRuleOpNotMatchRegex ConfigurationTriggersLoadRulesZarazLoadRuleOp = "NOT\_MATCH\_REGEX" Link to this property const ConfigurationTriggersLoadRulesZarazLoadRuleOpGreaterThan ConfigurationTriggersLoadRulesZarazLoadRuleOp = "GREATER\_THAN" Link to this property const ConfigurationTriggersLoadRulesZarazLoadRuleOpGreaterThanOrEqual ConfigurationTriggersLoadRulesZarazLoadRuleOp = "GREATER\_THAN\_OR\_EQUAL" Link to this property const ConfigurationTriggersLoadRulesZarazLoadRuleOpLessThan ConfigurationTriggersLoadRulesZarazLoadRuleOp = "LESS\_THAN" Link to this property const ConfigurationTriggersLoadRulesZarazLoadRuleOpLessThanOrEqual ConfigurationTriggersLoadRulesZarazLoadRuleOp = "LESS\_THAN\_OR\_EQUAL" Link to this property
Link to this property Value string Link to this property
Link to this property
type ConfigurationTriggersLoadRulesZarazClickListenerRule struct{…} ID string Link to this property Action ConfigurationTriggersLoadRulesZarazClickListenerRuleAction Link to this property
Settings ConfigurationTriggersLoadRulesZarazClickListenerRuleSettings Selector string Link to this property
Type ConfigurationTriggersLoadRulesZarazClickListenerRuleSettingsType One of the following: const ConfigurationTriggersLoadRulesZarazClickListenerRuleSettingsTypeXpath ConfigurationTriggersLoadRulesZarazClickListenerRuleSettingsType = "xpath" Link to this property const ConfigurationTriggersLoadRulesZarazClickListenerRuleSettingsTypeCSS ConfigurationTriggersLoadRulesZarazClickListenerRuleSettingsType = "css" Link to this property
Link to this property WaitForTags int64 minimum0 Link to this property
Link to this property
Link to this property
type ConfigurationTriggersLoadRulesZarazTimerRule struct{…} ID string Link to this property Action ConfigurationTriggersLoadRulesZarazTimerRuleAction Link to this property
Settings ConfigurationTriggersLoadRulesZarazTimerRuleSettings Interval int64 minimum50 Link to this property Limit int64 minimum0 Link to this property
Link to this property
Link to this property
type ConfigurationTriggersLoadRulesZarazFormSubmissionRule struct{…} ID string Link to this property Action ConfigurationTriggersLoadRulesZarazFormSubmissionRuleAction Link to this property
Settings ConfigurationTriggersLoadRulesZarazFormSubmissionRuleSettings Selector string Link to this property Validate bool Link to this property
Link to this property
Link to this property
type ConfigurationTriggersLoadRulesZarazVariableMatchRule struct{…} ID string Link to this property Action ConfigurationTriggersLoadRulesZarazVariableMatchRuleAction Link to this property
Settings ConfigurationTriggersLoadRulesZarazVariableMatchRuleSettings Match string Link to this property Variable string Link to this property
Link to this property
Link to this property
type ConfigurationTriggersLoadRulesZarazScrollDepthRule struct{…} ID string Link to this property Action ConfigurationTriggersLoadRulesZarazScrollDepthRuleAction Link to this property
Settings ConfigurationTriggersLoadRulesZarazScrollDepthRuleSettings Positions string Link to this property
Link to this property
Link to this property
type ConfigurationTriggersLoadRulesZarazElementVisibilityRule struct{…} ID string Link to this property Action ConfigurationTriggersLoadRulesZarazElementVisibilityRuleAction Link to this property
Settings ConfigurationTriggersLoadRulesZarazElementVisibilityRuleSettings Selector string Link to this property
Link to this property
Link to this property
Link to this property Name string Trigger name. Link to this property Description stringOptional Trigger description. Link to this property System ConfigurationTriggersSystemOptional Link to this property
Link to this property
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 Link to this property Type ConfigurationVariablesZarazStringVariableType Link to this property Value string Link to this property
Link to this property
type ConfigurationVariablesZarazSecretVariable struct{…} Name string Link to this property Type ConfigurationVariablesZarazSecretVariableType Link to this property Value string Link to this property
Link to this property
type ConfigurationVariablesZarazWorkerVariable struct{…} Name string Link to this property Type ConfigurationVariablesZarazWorkerVariableType Link to this property
Value ConfigurationVariablesZarazWorkerVariableValue EscapedWorkerName string Link to this property WorkerTag string Link to this property
Link to this property
Link to this property
Link to this property ZarazVersion int64 Zaraz internal version of the config. Link to this property
Analytics ConfigurationAnalyticsOptional Cloudflare Monitoring settings. DefaultPurpose stringOptional Consent purpose assigned to Monitoring. Link to this property Enabled boolOptional Whether Advanced Monitoring reports are enabled. Link to this property SessionExpTime int64Optional Session expiration time (seconds). maximum86400 minimum60 Link to this property
Link to this property
Consent ConfigurationConsentOptional Consent management configuration. Enabled bool Link to this property ButtonTextTranslations ButtonTextTranslationOptional Link to this property CompanyEmail stringOptional Link to this property CompanyName stringOptional Link to this property CompanyStreetAddress stringOptional Link to this property ConsentModalIntroHTML stringOptional Link to this property ConsentModalIntroHTMLWithTranslations map\[string, string]Optional Object where keys are language codes. Link to this property CookieName stringOptional Link to this property CustomCSS stringOptional Link to this property CustomIntroDisclaimerDismissed boolOptional Link to this property DefaultLanguage stringOptional Link to this property HideModal boolOptional Link to this property
Purposes map\[string, ConfigurationConsentPurpose]Optional Object where keys are purpose alpha-numeric IDs. Description string Link to this property Name string Link to this property
Link to this property
PurposesWithTranslations map\[string, ConfigurationConsentPurposesWithTranslation]Optional Object where keys are purpose alpha-numeric IDs. Description map\[string, string] Object where keys are language codes. Link to this property Name map\[string, string] Object where keys are language codes. Link to this property Order int64 Link to this property
Link to this property TcfCompliant boolOptional Link to this property
Link to this property HistoryChange boolOptional Single Page Application support enabled. Link to this property
[Link to this property](<#(resource)%20zaraz.config%20%3E%20(model)%20configuration%20%3E%20(schema)>) #### ZarazDefault ##### [Get default Zaraz configuration](https://developers.cloudflare.com/api/go/resources/zaraz/subresources/default/methods/get) client.Zaraz.Default.Get(ctx, query) (\*[Configuration](), error) GET/zones/{zone\_id}/settings/zaraz/default #### ZarazExport ##### [Export Zaraz configuration](https://developers.cloudflare.com/api/go/resources/zaraz/subresources/export/methods/get) client.Zaraz.Export.Get(ctx, query) (\*[Configuration](), error) GET/zones/{zone\_id}/settings/zaraz/export #### ZarazHistory ##### [List Zaraz historical configuration records](https://developers.cloudflare.com/api/go/resources/zaraz/subresources/history/methods/list) client.Zaraz.History.List(ctx, params) (\*SinglePage\[[HistoryListResponse]()], error) GET/zones/{zone\_id}/settings/zaraz/history ##### [Restore Zaraz historical configuration by ID](https://developers.cloudflare.com/api/go/resources/zaraz/subresources/history/methods/update) client.Zaraz.History.Update(ctx, params) (\*[Configuration](), error) PUT/zones/{zone\_id}/settings/zaraz/history #### ZarazHistoryConfigs ##### [Get Zaraz historical configurations by ID(s)](https://developers.cloudflare.com/api/go/resources/zaraz/subresources/history/subresources/configs/methods/get) client.Zaraz.History.Configs.Get(ctx, params) (\*[HistoryConfigGetResponse](), error) GET/zones/{zone\_id}/settings/zaraz/history/configs #### ZarazPublish ##### [Publish Zaraz preview configuration](https://developers.cloudflare.com/api/go/resources/zaraz/subresources/publish/methods/create) client.Zaraz.Publish.New(ctx, params) (\*string, error) POST/zones/{zone\_id}/settings/zaraz/publish #### ZarazWorkflow ##### [Get Zaraz workflow](https://developers.cloudflare.com/api/go/resources/zaraz/subresources/workflow/methods/get) client.Zaraz.Workflow.Get(ctx, query) (\*[Workflow](), error) GET/zones/{zone\_id}/settings/zaraz/workflow ##### ModelsExpand Collapse
type Workflow string Zaraz workflow. One of the following: const WorkflowRealtime Workflow = "realtime" Link to this property const WorkflowPreview Workflow = "preview" Link to this property
[Link to this property](<#(resource)%20zaraz.workflow%20%3E%20(model)%20workflow%20%3E%20(schema)>)