--- title: Zaraz --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) 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/typescript/resources/zaraz/methods/update) client.zaraz.update(ZarazUpdateParams {zone\_id, workflow } params, RequestOptionsoptions?): [Workflow]() PUT/zones/{zone\_id}/settings/zaraz/workflow ##### ModelsExpand Collapse

ButtonTextTranslation {accept\_all, confirm\_my\_choices, reject\_all }

accept\_all: Record<string, string> Object where keys are language codes. Link to this property confirm\_my\_choices: Record<string, string> Object where keys are language codes. Link to this property reject\_all: Record<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)>)

NeoEvent {actionType, blockingTriggers, data, firingTriggers }

actionType: string Tool event type. Link to this property blockingTriggers: Array<string> List of blocking triggers IDs. Link to this property data: unknown Event payload. Link to this property firingTriggers: Array<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/typescript/resources/zaraz/subresources/config/methods/get) client.zaraz.config.get(ConfigGetParams {zone\_id } params, RequestOptionsoptions?): [Configuration]() {dataLayer, debugKey, settings, 7 more } GET/zones/{zone\_id}/settings/zaraz/config ##### [Update Zaraz configuration](https://developers.cloudflare.com/api/typescript/resources/zaraz/subresources/config/methods/update) client.zaraz.config.update(ConfigUpdateParams {zone\_id, dataLayer, debugKey, 8 more } params, RequestOptionsoptions?): [Configuration]() {dataLayer, debugKey, settings, 7 more } PUT/zones/{zone\_id}/settings/zaraz/config ##### ModelsExpand Collapse

Configuration {dataLayer, debugKey, settings, 7 more } Zaraz configuration.

dataLayer: boolean Data layer compatibility mode enabled. Link to this property debugKey: string The key for Zaraz debug mode. Link to this property

settings: Settings {autoInjectScript, contextEnricher, cookieDomain, 11 more } General Zaraz settings.

autoInjectScript: boolean Automatic injection of Zaraz scripts enabled. Link to this property

contextEnricher?: ContextEnricher {escapedWorkerName, workerTag } 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?: string The domain Zaraz will use for writing and reading its cookies. Link to this property ecommerce?: boolean Ecommerce API enabled. Link to this property eventsApiPath?: string Custom endpoint for server-side track events. Link to this property hideExternalReferer?: boolean Hiding external referrer URL enabled. Link to this property hideIPAddress?: boolean Trimming IP address enabled. Link to this property hideQueryParams?: boolean Removing URL query params enabled. Link to this property hideUserAgent?: boolean Removing sensitive data from User Agent string enabled. Link to this property initPath?: string Custom endpoint for Zaraz init script. Link to this property injectIframes?: boolean Injection of Zaraz scripts into iframes enabled. Link to this property mcRootPath?: string Custom path for Managed Components server functionalities. Link to this property scriptPath?: string Custom endpoint for Zaraz main script. Link to this property trackPath?: string Custom endpoint for Zaraz tracking requests. Link to this property

Link to this property

tools: Record<string, ZarazManagedComponent {blockingTriggers, component, defaultFields, 10 more } | Worker {blockingTriggers, component, defaultFields, 11 more } > 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:

ZarazManagedComponent {blockingTriggers, component, defaultFields, 10 more }

blockingTriggers: Array<string> List of blocking trigger IDs. Link to this property component: string Tool’s internal name. Link to this property

defaultFields: Record<string, string| boolean> Default fields for tool’s actions.

One of the following: string Link to this property boolean Link to this property

Link to this property enabled: boolean Whether tool is enabled. Link to this property name: string Tool’s name defined by the user. Link to this property permissions: Array<string> List of permissions granted to the component. Link to this property

settings: Record<string, string| boolean> Tool’s settings.

One of the following: string Link to this property boolean Link to this property

Link to this property type: "component" Link to this property

actions?: Record<string, NeoEvent {actionType, blockingTriggers, data, firingTriggers } > Actions configured on a tool. Either this or neoEvents field is required.

Link to this property defaultPurpose?: string Default consent purpose ID. Link to this property

neoEvents?: Array<NeoEvent {actionType, blockingTriggers, data, firingTriggers } > DEPRECATED - List of actions configured on a tool. Either this or actions field is required. If both are present, actions field will take precedence.

Link to this property vendorName?: string 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?: string 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

Worker {blockingTriggers, component, defaultFields, 11 more }

blockingTriggers: Array<string> List of blocking trigger IDs. Link to this property component: string Tool’s internal name. Link to this property

defaultFields: Record<string, string| boolean> Default fields for tool’s actions.

One of the following: string Link to this property boolean Link to this property

settings: Record<string, string| boolean> Tool’s settings.

One of the following: string Link to this property boolean Link to this property

Link to this property type: "custom-mc" Link to this property

worker: Worker {escapedWorkerName, workerTag } 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?: Record<string, NeoEvent {actionType, blockingTriggers, data, firingTriggers } > Actions configured on a tool. Either this or neoEvents field is required.

Link to this property defaultPurpose?: string Default consent purpose ID. Link to this property

Link to this property

triggers: Record<string, Triggers> Triggers set up under Zaraz configuration, where key is the trigger alpha-numeric ID and value is the trigger configuration.

excludeRules: Array<ZarazLoadRule {id, match, op, value } | ZarazClickListenerRule {id, action, settings } | ZarazTimerRule {id, action, settings } | 4 more> Rules defining when the trigger is not fired.

One of the following:

ZarazLoadRule {id, match, op, value }

id: string Link to this property match: string Link to this property

op: "CONTAINS"| "EQUALS"| "STARTS\_WITH"| 7 more

One of the following: "CONTAINS" Link to this property "EQUALS" Link to this property "STARTS\_WITH" Link to this property "ENDS\_WITH" Link to this property "MATCH\_REGEX" Link to this property "NOT\_MATCH\_REGEX" Link to this property "GREATER\_THAN" Link to this property "GREATER\_THAN\_OR\_EQUAL" Link to this property "LESS\_THAN" Link to this property "LESS\_THAN\_OR\_EQUAL" Link to this property

Link to this property value: string Link to this property

Link to this property

ZarazClickListenerRule {id, action, settings }

id: string Link to this property action: "clickListener" Link to this property

settings: Settings {selector, type, waitForTags }

selector: string Link to this property

type: "xpath"| "css"

One of the following: "xpath" Link to this property "css" Link to this property

Link to this property waitForTags: number minimum0 Link to this property

Link to this property

ZarazTimerRule {id, action, settings }

id: string Link to this property action: "timer" Link to this property

settings: Settings {interval, limit }

interval: number minimum50 Link to this property limit: number minimum0 Link to this property

Link to this property

ZarazFormSubmissionRule {id, action, settings }

id: string Link to this property action: "formSubmission" Link to this property

settings: Settings {selector, validate }

selector: string Link to this property validate: boolean Link to this property

Link to this property

ZarazVariableMatchRule {id, action, settings }

id: string Link to this property action: "variableMatch" Link to this property

settings: Settings {match, variable }

match: string Link to this property variable: string Link to this property

Link to this property

ZarazScrollDepthRule {id, action, settings }

id: string Link to this property action: "scrollDepth" Link to this property

settings: Settings {positions }

positions: string Link to this property

Link to this property

ZarazElementVisibilityRule {id, action, settings }

id: string Link to this property action: "elementVisibility" Link to this property

settings: Settings {selector }

selector: string Link to this property

Link to this property

loadRules: Array<ZarazLoadRule {id, match, op, value } | ZarazClickListenerRule {id, action, settings } | ZarazTimerRule {id, action, settings } | 4 more> Rules defining when the trigger is fired.

One of the following:

ZarazLoadRule {id, match, op, value }

id: string Link to this property match: string Link to this property

op: "CONTAINS"| "EQUALS"| "STARTS\_WITH"| 7 more

Link to this property value: string Link to this property

Link to this property

ZarazClickListenerRule {id, action, settings }

id: string Link to this property action: "clickListener" Link to this property

settings: Settings {selector, type, waitForTags }

selector: string Link to this property

type: "xpath"| "css"

One of the following: "xpath" Link to this property "css" Link to this property

Link to this property waitForTags: number minimum0 Link to this property

Link to this property

ZarazTimerRule {id, action, settings }

id: string Link to this property action: "timer" Link to this property

settings: Settings {interval, limit }

interval: number minimum50 Link to this property limit: number minimum0 Link to this property

Link to this property

ZarazFormSubmissionRule {id, action, settings }

id: string Link to this property action: "formSubmission" Link to this property

settings: Settings {selector, validate }

selector: string Link to this property validate: boolean Link to this property

Link to this property

ZarazVariableMatchRule {id, action, settings }

id: string Link to this property action: "variableMatch" Link to this property

settings: Settings {match, variable }

match: string Link to this property variable: string Link to this property

Link to this property

ZarazScrollDepthRule {id, action, settings }

id: string Link to this property action: "scrollDepth" Link to this property

settings: Settings {positions }

positions: string Link to this property

Link to this property

ZarazElementVisibilityRule {id, action, settings }

id: string Link to this property action: "elementVisibility" Link to this property

settings: Settings {selector }

selector: string Link to this property

Link to this property

Link to this property name: string Trigger name. Link to this property description?: string Trigger description. Link to this property system?: "pageload" Link to this property

Link to this property

variables: Record<string, ZarazStringVariable {name, type, value } | ZarazSecretVariable {name, type, value } | ZarazWorkerVariable {name, type, value } > 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:

ZarazStringVariable {name, type, value }

name: string Link to this property type: "string" Link to this property value: string Link to this property

Link to this property

ZarazSecretVariable {name, type, value }

name: string Link to this property type: "secret" Link to this property value: string Link to this property

Link to this property

ZarazWorkerVariable {name, type, value }

name: string Link to this property type: "worker" Link to this property

value: Value {escapedWorkerName, workerTag }

escapedWorkerName: string Link to this property workerTag: string Link to this property

Link to this property

Link to this property zarazVersion: number Zaraz internal version of the config. Link to this property

analytics?: Analytics {defaultPurpose, enabled, sessionExpTime } Cloudflare Monitoring settings.

defaultPurpose?: string Consent purpose assigned to Monitoring. Link to this property enabled?: boolean Whether Advanced Monitoring reports are enabled. Link to this property sessionExpTime?: number Session expiration time (seconds). maximum86400 minimum60 Link to this property

Link to this property

consent?: Consent {enabled, buttonTextTranslations, companyEmail, 12 more } Consent management configuration.

enabled: boolean Link to this property buttonTextTranslations?: ButtonTextTranslation {accept\_all, confirm\_my\_choices, reject\_all } Link to this property companyEmail?: string Link to this property companyName?: string Link to this property companyStreetAddress?: string Link to this property consentModalIntroHTML?: string Link to this property consentModalIntroHTMLWithTranslations?: Record<string, string> Object where keys are language codes. Link to this property cookieName?: string Link to this property customCSS?: string Link to this property customIntroDisclaimerDismissed?: boolean Link to this property defaultLanguage?: string Link to this property hideModal?: boolean Link to this property

purposes?: Record<string, Purposes> 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?: Record<string, PurposesWithTranslations> Object where keys are purpose alpha-numeric IDs.

description: Record<string, string> Object where keys are language codes. Link to this property name: Record<string, string> Object where keys are language codes. Link to this property order: number Link to this property

Link to this property tcfCompliant?: boolean Link to this property

Link to this property historyChange?: boolean 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/typescript/resources/zaraz/subresources/default/methods/get) client.zaraz.default.get(DefaultGetParams {zone\_id } params, RequestOptionsoptions?): [Configuration]() {dataLayer, debugKey, settings, 7 more } GET/zones/{zone\_id}/settings/zaraz/default #### ZarazExport ##### [Export Zaraz configuration](https://developers.cloudflare.com/api/typescript/resources/zaraz/subresources/export/methods/get) client.zaraz.export.get(ExportGetParams {zone\_id } params, RequestOptionsoptions?): [Configuration]() {dataLayer, debugKey, settings, 7 more } GET/zones/{zone\_id}/settings/zaraz/export #### ZarazHistory ##### [List Zaraz historical configuration records](https://developers.cloudflare.com/api/typescript/resources/zaraz/subresources/history/methods/list) client.zaraz.history.list(HistoryListParams {zone\_id, limit, offset, 2 more } params, RequestOptionsoptions?): SinglePage< [HistoryListResponse]() {id, createdAt, description, 2 more } > GET/zones/{zone\_id}/settings/zaraz/history ##### [Restore Zaraz historical configuration by ID](https://developers.cloudflare.com/api/typescript/resources/zaraz/subresources/history/methods/update) client.zaraz.history.update(HistoryUpdateParams {zone\_id, body } params, RequestOptionsoptions?): [Configuration]() {dataLayer, debugKey, settings, 7 more } PUT/zones/{zone\_id}/settings/zaraz/history ##### ModelsExpand Collapse

HistoryListResponse {id, createdAt, description, 2 more }

id: number ID of the configuration. Link to this property createdAt: string Date and time the configuration was created. formatdate-time Link to this property description: string Configuration description provided by the user who published this configuration. Link to this property updatedAt: string Date and time the configuration was last updated. formatdate-time Link to this property userId: string Alpha-numeric ID of the account user who published the configuration. Link to this property

[Link to this property](<#(resource)%20zaraz.history%20%3E%20(model)%20history_list_response%20%3E%20(schema)>) #### ZarazHistoryConfigs ##### [Get Zaraz historical configurations by ID(s)](https://developers.cloudflare.com/api/typescript/resources/zaraz/subresources/history/subresources/configs/methods/get) client.zaraz.history.configs.get(ConfigGetParams {zone\_id, ids } params, RequestOptionsoptions?): [ConfigGetResponse]() {id, config, createdAt, 2 more } GET/zones/{zone\_id}/settings/zaraz/history/configs ##### ModelsExpand Collapse

ConfigGetResponse = Record<string, item> Object where keys are numeric configuration IDs.

id: number ID of the configuration. Link to this property config: Configuration {dataLayer, debugKey, settings, 7 more } Zaraz configuration. Link to this property createdAt: string Date and time the configuration was created. formatdate-time Link to this property updatedAt: string Date and time the configuration was last updated. formatdate-time Link to this property userId: string Alpha-numeric ID of the account user who published the configuration. Link to this property

[Link to this property](<#(resource)%20zaraz.history.configs%20%3E%20(model)%20config_get_response%20%3E%20(schema)>) #### ZarazPublish ##### [Publish Zaraz preview configuration](https://developers.cloudflare.com/api/typescript/resources/zaraz/subresources/publish/methods/create) client.zaraz.publish.create(PublishCreateParams {zone\_id, body } params, RequestOptionsoptions?): [PublishCreateResponse]() POST/zones/{zone\_id}/settings/zaraz/publish ##### ModelsExpand Collapse PublishCreateResponse = string [Link to this property](<#(resource)%20zaraz.publish%20%3E%20(model)%20publish_create_response%20%3E%20(schema)>) #### ZarazWorkflow ##### [Get Zaraz workflow](https://developers.cloudflare.com/api/typescript/resources/zaraz/subresources/workflow/methods/get) client.zaraz.workflow.get(WorkflowGetParams {zone\_id } params, RequestOptionsoptions?): [Workflow]() GET/zones/{zone\_id}/settings/zaraz/workflow ##### ModelsExpand Collapse

Workflow = "realtime"| "preview" Zaraz workflow.

One of the following: "realtime" Link to this property "preview" Link to this property

[Link to this property](<#(resource)%20zaraz.workflow%20%3E%20(model)%20workflow%20%3E%20(schema)>)