> ## Documentation Index > Fetch the complete documentation index at: https://doc.extole.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a prehandler > Applies a partial update to the supplied prehandler. Only the fields present in the body are changed; omitted fields are left intact. Returns the persisted prehandler after the update. Returns `400 prehandler_not_found` if the id does not exist. ## OpenAPI ````yaml /api-reference/management-expert.json put /v6/prehandlers/{prehandlerId} openapi: 3.0.1 info: description: >- Advanced configuration endpoints for Extole platform experts: campaign controllers, typed actions and triggers, advanced component types and facets, source mapping, report post-handlers, pre-handlers, and other expert configuration surfaces not included in the standard Management API. title: Management Expert API version: '1.0' servers: - description: Production url: https://api.extole.io security: - HEADER: [] - QUERY: [] - COOKIE: [] tags: - name: Authentication - name: Campaign Controllers - name: Campaign Controllers Actions - name: Campaign Controllers Triggers - name: Campaign Flow Steps - name: Components - name: Components Grants - name: Components Subscriptions - name: Components Types - name: Content - name: Debug - name: Domains - name: Email - name: Event Prehandlers - name: Events - name: Javascript Core Extensions - name: Persons - name: Profiles - name: Report Schedules - name: Report Types - name: Reporting - name: Security Keys - name: Settings paths: /v6/prehandlers/{prehandlerId}: put: tags: - Event Prehandlers summary: Update a prehandler description: >- Applies a partial update to the supplied prehandler. Only the fields present in the body are changed; omitted fields are left intact. Returns the persisted prehandler after the update. Returns `400 prehandler_not_found` if the id does not exist. operationId: updatePrehandler parameters: - description: The id of the prehandler to be updated. in: path name: prehandlerId required: true schema: type: string requestBody: content: application/json: example: actions: - expression: {} type: EXPRESSION component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name conditions: - considered_block_list_types: - CIDR type: BLOCK_MATCH description: description enabled: true name: name order: 1 tags: - tag schema: $ref: '#/components/schemas/PrehandlerUpdateRequest' description: PrehandlerUpdateRequest object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PrehandlerResponse' description: >- Prehandler source definition with build-time fields, conditions, actions, execution order, and component references. '400': content: application/json: examples: prehandler_not_found: $ref: '#/components/examples/prehandler_not_found' schema: $ref: '#/components/schemas/RestExceptionResponse' description: >- Prehandler was not found. The supplied id does not match any prehandler accessible to the calling client. '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests components: schemas: PrehandlerUpdateRequest: description: Body of a `PUT /v6/prehandlers/{prehandlerId}` request. properties: actions: items: $ref: '#/components/schemas/PrehandlerActionRequest' type: array component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array conditions: items: $ref: '#/components/schemas/PrehandlerConditionRequest' type: array description: $ref: '#/components/schemas/DescriptionInPrehandlerUpdateRequest' enabled: $ref: '#/components/schemas/EnabledInPrehandlerUpdateRequest' name: $ref: '#/components/schemas/NameInPrehandlerUpdateRequest' order: $ref: '#/components/schemas/OrderInPrehandlerUpdateRequest' tags: items: type: string type: array uniqueItems: true type: object PrehandlerResponse: description: >- Prehandler source definition with build-time fields, conditions, actions, and execution order. properties: actions: description: Actions executed when the prehandler conditions match. items: $ref: '#/components/schemas/PrehandlerActionResponse' type: array component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array conditions: description: Conditions that must match before the prehandler actions run. items: $ref: '#/components/schemas/PrehandlerConditionResponse' type: array created_date: $ref: '#/components/schemas/ZonedDateTime' description: $ref: '#/components/schemas/DescriptionInPrehandlerResponse' enabled: $ref: '#/components/schemas/EnabledInPrehandlerResponse' id: description: Unique identifier for the prehandler. readOnly: true type: string name: $ref: '#/components/schemas/NameInPrehandlerResponse' order: $ref: '#/components/schemas/OrderInPrehandlerResponse' tags: description: Tags used to classify or filter the prehandler. items: description: Tags used to classify or filter the prehandler. type: string type: array uniqueItems: true updated_date: $ref: '#/components/schemas/ZonedDateTime' required: - actions - component_ids - component_references - conditions - created_date - description - enabled - id - name - order - tags - updated_date type: object RestExceptionResponse: description: Represents the API error response properties: code: description: Specific error code for this error type, documented per endpoint type: string http_status_code: description: >- HTTP status code that was returned with this error, useful if client get response code format: int32 type: integer message: description: User readable English description of the error type: string parameters: additionalProperties: description: >- Attributes related to the error, varies be error code, documented per endpoint type: object description: >- Attributes related to the error, varies be error code, documented per endpoint type: object unique_id: description: >- Unique id associated with this error, useful for discussions with Extole type: string required: - code - http_status_code - message - parameters - unique_id type: object PrehandlerActionRequest: discriminator: mapping: EXPRESSION: $ref: '#/components/schemas/ExpressionPrehandlerActionRequest' JAVASCRIPT_V1: $ref: '#/components/schemas/JavascriptPrehandlerActionRequest' MAP_DATA_ATTRIBUTES: $ref: '#/components/schemas/MapDataAttributesPrehandlerActionRequest' SET_DATA: $ref: '#/components/schemas/SetDataPrehandlerActionRequest' SET_SANDBOX: $ref: '#/components/schemas/SetSandboxPrehandlerActionRequest' propertyName: type oneOf: - title: EXPRESSION allOf: - $ref: '#/components/schemas/ExpressionPrehandlerActionRequest' - title: JAVASCRIPT_V1 allOf: - $ref: '#/components/schemas/JavascriptPrehandlerActionRequest' - title: MAP_DATA_ATTRIBUTES allOf: - $ref: '#/components/schemas/MapDataAttributesPrehandlerActionRequest' - title: SET_DATA allOf: - $ref: '#/components/schemas/SetDataPrehandlerActionRequest' - title: SET_SANDBOX allOf: - $ref: '#/components/schemas/SetSandboxPrehandlerActionRequest' required: - type ComponentReferenceRequest: properties: component_id: type: string socket_names: items: type: string type: array type: object PrehandlerConditionRequest: discriminator: mapping: BLOCK_MATCH: $ref: '#/components/schemas/BlockMatchPrehandlerConditionRequest' DATA_EXISTS: $ref: '#/components/schemas/DataExistsPrehandlerConditionRequest' EVENT_NAME_MATCH: $ref: '#/components/schemas/EventNameMatchPrehandlerConditionRequest' EXPRESSION: $ref: '#/components/schemas/ExpressionPrehandlerConditionRequest' HTTP_HEADER_MATCH: $ref: '#/components/schemas/HttpHeaderMatchPrehandlerConditionRequest' JAVASCRIPT_V1: $ref: '#/components/schemas/JavascriptPrehandlerConditionRequest' propertyName: type oneOf: - title: BLOCK_MATCH allOf: - $ref: '#/components/schemas/BlockMatchPrehandlerConditionRequest' - title: DATA_EXISTS allOf: - $ref: '#/components/schemas/DataExistsPrehandlerConditionRequest' - title: EVENT_NAME_MATCH allOf: - $ref: '#/components/schemas/EventNameMatchPrehandlerConditionRequest' - title: EXPRESSION allOf: - $ref: '#/components/schemas/ExpressionPrehandlerConditionRequest' - title: HTTP_HEADER_MATCH allOf: - $ref: '#/components/schemas/HttpHeaderMatchPrehandlerConditionRequest' - title: JAVASCRIPT_V1 allOf: - $ref: '#/components/schemas/JavascriptPrehandlerConditionRequest' required: - type DescriptionInPrehandlerUpdateRequest: description: Choose between static or dynamic description oneOf: - description: Static description nullable: true title: Static Value type: string - description: >- Handlebars expression with [PrehandlerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: PrehandlerBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [PrehandlerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: PrehandlerBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EnabledInPrehandlerUpdateRequest: description: Choose between static or dynamic enabled oneOf: - description: Static enabled nullable: true title: Static Value type: boolean - description: >- Handlebars expression with [PrehandlerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: PrehandlerBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [PrehandlerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: PrehandlerBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string NameInPrehandlerUpdateRequest: description: Prehandler name must be unique. oneOf: - allOf: - nullable: true type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static name title: Static Value - description: >- Handlebars expression with [PrehandlerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts). example: handlebars@buildtime:{{name}} externalDocs: description: PrehandlerBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [PrehandlerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('name');} externalDocs: description: PrehandlerBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string OrderInPrehandlerUpdateRequest: description: Choose between static or dynamic order oneOf: - description: Static order format: int32 nullable: true title: Static Value type: integer - description: >- Handlebars expression with [PrehandlerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts). example: handlebars@buildtime:{{order}} externalDocs: description: PrehandlerBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [PrehandlerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('order');} externalDocs: description: PrehandlerBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string PrehandlerActionResponse: description: Actions executed when the prehandler conditions match. discriminator: mapping: EXPRESSION: $ref: '#/components/schemas/ExpressionPrehandlerActionResponse' JAVASCRIPT_V1: $ref: '#/components/schemas/JavascriptPrehandlerActionResponse' MAP_DATA_ATTRIBUTES: $ref: '#/components/schemas/MapDataAttributesPrehandlerActionResponse' SET_DATA: $ref: '#/components/schemas/SetDataPrehandlerActionResponse' SET_SANDBOX: $ref: '#/components/schemas/SetSandboxPrehandlerActionResponse' propertyName: type oneOf: - title: EXPRESSION allOf: - $ref: '#/components/schemas/ExpressionPrehandlerActionResponse' - title: JAVASCRIPT_V1 allOf: - $ref: '#/components/schemas/JavascriptPrehandlerActionResponse' - title: MAP_DATA_ATTRIBUTES allOf: - $ref: '#/components/schemas/MapDataAttributesPrehandlerActionResponse' - title: SET_DATA allOf: - $ref: '#/components/schemas/SetDataPrehandlerActionResponse' - title: SET_SANDBOX allOf: - $ref: '#/components/schemas/SetSandboxPrehandlerActionResponse' ComponentReferenceResponse: properties: component_id: type: string socket_names: items: type: string type: array type: object PrehandlerConditionResponse: description: Conditions that must match before the prehandler actions run. discriminator: mapping: BLOCK_MATCH: $ref: '#/components/schemas/BlockMatchPrehandlerConditionResponse' DATA_EXISTS: $ref: '#/components/schemas/DataExistsPrehandlerConditionResponse' EVENT_NAME_MATCH: $ref: '#/components/schemas/EventNameMatchPrehandlerConditionResponse' EXPRESSION: $ref: '#/components/schemas/ExpressionPrehandlerConditionResponse' HTTP_HEADER_MATCH: $ref: '#/components/schemas/HttpHeaderMatchPrehandlerConditionResponse' JAVASCRIPT_V1: $ref: '#/components/schemas/JavascriptPrehandlerConditionResponse' propertyName: type oneOf: - title: BLOCK_MATCH allOf: - $ref: '#/components/schemas/BlockMatchPrehandlerConditionResponse' - title: DATA_EXISTS allOf: - $ref: '#/components/schemas/DataExistsPrehandlerConditionResponse' - title: EVENT_NAME_MATCH allOf: - $ref: '#/components/schemas/EventNameMatchPrehandlerConditionResponse' - title: EXPRESSION allOf: - $ref: '#/components/schemas/ExpressionPrehandlerConditionResponse' - title: HTTP_HEADER_MATCH allOf: - $ref: '#/components/schemas/HttpHeaderMatchPrehandlerConditionResponse' - title: JAVASCRIPT_V1 allOf: - $ref: '#/components/schemas/JavascriptPrehandlerConditionResponse' ZonedDateTime: description: >- [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. example: '2025-10-24T02:00:00-07:00' pattern: >- ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$ type: string DescriptionInPrehandlerResponse: description: >- Optional build-time expression that resolves to the prehandler description. oneOf: - description: Literal description nullable: true title: Static Value type: string - description: >- Handlebars expression with [PrehandlerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts). example: handlebars@buildtime:{{description}} externalDocs: description: PrehandlerBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [PrehandlerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('description');} externalDocs: description: PrehandlerBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string EnabledInPrehandlerResponse: description: Build-time expression that controls whether the prehandler is active. oneOf: - description: Literal enabled title: Static Value type: boolean - description: >- Handlebars expression with [PrehandlerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts). example: handlebars@buildtime:{{enabled}} externalDocs: description: PrehandlerBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [PrehandlerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('enabled');} externalDocs: description: PrehandlerBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string NameInPrehandlerResponse: description: Build-time expression that resolves to the prehandler name. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Literal name title: Static Value - description: >- Handlebars expression with [PrehandlerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts). example: handlebars@buildtime:{{name}} externalDocs: description: PrehandlerBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [PrehandlerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('name');} externalDocs: description: PrehandlerBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string OrderInPrehandlerResponse: description: Build-time expression that controls the prehandler execution order. oneOf: - description: Literal order format: int32 title: Static Value type: integer - description: >- Handlebars expression with [PrehandlerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts). example: handlebars@buildtime:{{order}} externalDocs: description: PrehandlerBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [PrehandlerBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('order');} externalDocs: description: PrehandlerBuildtimeContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/built/PrehandlerBuildtimeContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string ExpressionPrehandlerActionRequest: allOf: - $ref: '#/components/schemas/PrehandlerActionRequestBase' - properties: expression: $ref: >- #/components/schemas/ExpressionInExpressionPrehandlerActionRequest type: enum: - EXPRESSION type: string type: object description: Action represented by expression that can change the event. required: - expression - type type: object title: EXPRESSION JavascriptPrehandlerActionRequest: allOf: - $ref: '#/components/schemas/PrehandlerActionRequestBase' - properties: javascript: type: string type: enum: - JAVASCRIPT_V1 type: string type: object description: Action represented by Javascript that can change the event. required: - javascript - type type: object title: JAVASCRIPT_V1 MapDataAttributesPrehandlerActionRequest: allOf: - $ref: '#/components/schemas/PrehandlerActionRequestBase' - properties: data_attribute_mappings: items: $ref: '#/components/schemas/DataAttributeMapping' type: array type: enum: - MAP_DATA_ATTRIBUTES type: string type: object description: Action that modifies the event data based on data mappers attributes. required: - data_attribute_mappings - type type: object title: MAP_DATA_ATTRIBUTES SetDataPrehandlerActionRequest: allOf: - $ref: '#/components/schemas/PrehandlerActionRequestBase' - properties: data: $ref: '#/components/schemas/DataMapInSetDataPrehandlerActionRequest' default_data: $ref: >- #/components/schemas/Default_dataMapInSetDataPrehandlerActionRequest delete_data: description: >- Names (keys) of the data that should be removed from the event. Data names (keys) are not case sensitive. items: description: >- Names (keys) of the data that should be removed from the event. Data names (keys) are not case sensitive. nullable: true type: string nullable: true type: array uniqueItems: true type: enum: - SET_DATA type: string type: object description: Action that modifies the event data. required: - data - default_data - delete_data - type type: object title: SET_DATA SetSandboxPrehandlerActionRequest: allOf: - $ref: '#/components/schemas/PrehandlerActionRequestBase' - properties: sandbox_id: description: Id of the sandbox to be set into the event. type: string type: enum: - SET_SANDBOX type: string type: object description: Action that modifies the event sandbox. required: - sandbox_id - type type: object title: SET_SANDBOX BlockMatchPrehandlerConditionRequest: allOf: - $ref: '#/components/schemas/PrehandlerConditionRequestBase' - properties: considered_block_list_types: description: >- Condition evaluates to true if any value from the list of any list type blocks matches the value from the event being evaluated. By default all list type blocks are evaluated. items: description: >- Condition evaluates to true if any value from the list of any list type blocks matches the value from the event being evaluated. By default all list type blocks are evaluated. enum: - CIDR - EMAIL_DOMAIN - NORMALIZED_EMAIL - USER_AGENT type: string type: array uniqueItems: true type: enum: - BLOCK_MATCH type: string type: object description: Condition that adds the block list types to be checked. required: - type type: object title: BLOCK_MATCH DataExistsPrehandlerConditionRequest: allOf: - $ref: '#/components/schemas/PrehandlerConditionRequestBase' - properties: data_keys: description: >- Condition evaluates to true if the data name is present in the event. Data name is not case sensitive. items: description: >- Condition evaluates to true if the data name is present in the event. Data name is not case sensitive. type: string type: array uniqueItems: true type: enum: - DATA_EXISTS type: string type: object description: Condition that checks the data name exists. required: - data_keys - type type: object title: DATA_EXISTS EventNameMatchPrehandlerConditionRequest: allOf: - $ref: '#/components/schemas/PrehandlerConditionRequestBase' - properties: event_names: description: >- Condition evaluates to true if the event name is present in this set. Event names are not case sensitive. items: description: >- Condition evaluates to true if the event name is present in this set. Event names are not case sensitive. type: string type: array uniqueItems: true type: enum: - EVENT_NAME_MATCH type: string type: object description: Condition that checks the event name. required: - event_names - type type: object title: EVENT_NAME_MATCH ExpressionPrehandlerConditionRequest: allOf: - $ref: '#/components/schemas/PrehandlerConditionRequestBase' - properties: expression: $ref: >- #/components/schemas/ExpressionInExpressionPrehandlerConditionRequest type: enum: - EXPRESSION type: string type: object description: >- Condition represented by expression. It evaluates to true if the expression returns true. required: - expression - type type: object title: EXPRESSION HttpHeaderMatchPrehandlerConditionRequest: allOf: - $ref: '#/components/schemas/PrehandlerConditionRequestBase' - properties: http_header_names: description: >- Condition evaluates to true if any of these HTTP headers are present in the request. HTTP header names are not case sensitive. items: description: >- Condition evaluates to true if any of these HTTP headers are present in the request. HTTP header names are not case sensitive. nullable: true type: string nullable: true type: array uniqueItems: true http_headers: additionalProperties: description: >- Condition evaluates to true if any of these HTTP headers are present in the request. At least one HTTP header value should match. HTTP header names are not case sensitive. items: description: >- Condition evaluates to true if any of these HTTP headers are present in the request. At least one HTTP header value should match. HTTP header names are not case sensitive. nullable: true type: string nullable: true type: array description: >- Condition evaluates to true if any of these HTTP headers are present in the request. At least one HTTP header value should match. HTTP header names are not case sensitive. nullable: true type: object type: enum: - HTTP_HEADER_MATCH type: string type: object description: Condition that checks the event HTTP headers. required: - http_header_names - http_headers - type type: object title: HTTP_HEADER_MATCH JavascriptPrehandlerConditionRequest: allOf: - $ref: '#/components/schemas/PrehandlerConditionRequestBase' - properties: javascript: type: string type: enum: - JAVASCRIPT_V1 type: string type: object description: >- Condition represented by Javascript. It evaluates to true if the javascript returns true. required: - javascript - type type: object title: JAVASCRIPT_V1 ExpressionPrehandlerActionResponse: allOf: - $ref: '#/components/schemas/PrehandlerActionResponseBase' - properties: expression: $ref: >- #/components/schemas/ExpressionInExpressionPrehandlerActionResponse id: readOnly: true type: string type: enum: - EXPRESSION type: string type: object description: Action represented by expression that can change the event. required: - expression - id - type type: object title: EXPRESSION JavascriptPrehandlerActionResponse: allOf: - $ref: '#/components/schemas/PrehandlerActionResponseBase' - properties: id: readOnly: true type: string javascript: type: string type: enum: - JAVASCRIPT_V1 type: string type: object description: Action represented by Javascript that can change the event. required: - id - javascript - type type: object title: JAVASCRIPT_V1 MapDataAttributesPrehandlerActionResponse: allOf: - $ref: '#/components/schemas/PrehandlerActionResponseBase' - properties: data_attribute_mappings: items: $ref: '#/components/schemas/DataAttributeMapping' type: array id: readOnly: true type: string type: enum: - MAP_DATA_ATTRIBUTES type: string type: object description: >- Action represented by data mappers that can change the data of the event. required: - data_attribute_mappings - id - type type: object title: MAP_DATA_ATTRIBUTES SetDataPrehandlerActionResponse: allOf: - $ref: '#/components/schemas/PrehandlerActionResponseBase' - properties: data: additionalProperties: nullable: true type: object nullable: true type: object default_data: additionalProperties: nullable: true type: object nullable: true type: object delete_data: items: nullable: true type: string nullable: true type: array uniqueItems: true id: readOnly: true type: string type: enum: - SET_DATA type: string type: object description: Action that modifies the event data. required: - data - default_data - delete_data - id - type type: object title: SET_DATA SetSandboxPrehandlerActionResponse: allOf: - $ref: '#/components/schemas/PrehandlerActionResponseBase' - properties: id: readOnly: true type: string sandbox_id: type: string type: enum: - SET_SANDBOX type: string type: object description: Action that modifies the event sandbox. required: - id - sandbox_id - type type: object title: SET_SANDBOX BlockMatchPrehandlerConditionResponse: allOf: - $ref: '#/components/schemas/PrehandlerConditionResponseBase' - properties: considered_block_list_types: items: enum: - CIDR - EMAIL_DOMAIN - NORMALIZED_EMAIL - USER_AGENT type: string type: array uniqueItems: true id: readOnly: true type: string type: enum: - BLOCK_MATCH type: string type: object description: Condition that adds the block list types to be checked. required: - considered_block_list_types - id - type type: object title: BLOCK_MATCH DataExistsPrehandlerConditionResponse: allOf: - $ref: '#/components/schemas/PrehandlerConditionResponseBase' - properties: data_keys: items: type: string type: array uniqueItems: true id: readOnly: true type: string type: enum: - DATA_EXISTS type: string type: object description: Condition that checks the data name exists. required: - data_keys - id - type type: object title: DATA_EXISTS EventNameMatchPrehandlerConditionResponse: allOf: - $ref: '#/components/schemas/PrehandlerConditionResponseBase' - properties: event_names: items: type: string type: array uniqueItems: true id: readOnly: true type: string type: enum: - EVENT_NAME_MATCH type: string type: object description: Condition that checks the event name. required: - event_names - id - type type: object title: EVENT_NAME_MATCH ExpressionPrehandlerConditionResponse: allOf: - $ref: '#/components/schemas/PrehandlerConditionResponseBase' - properties: expression: $ref: >- #/components/schemas/ExpressionInExpressionPrehandlerConditionResponse id: readOnly: true type: string type: enum: - EXPRESSION type: string type: object description: >- Condition represented by expression. It evaluates to true if the expression returns true. required: - expression - id - type type: object title: EXPRESSION HttpHeaderMatchPrehandlerConditionResponse: allOf: - $ref: '#/components/schemas/PrehandlerConditionResponseBase' - properties: http_header_names: items: type: string type: array uniqueItems: true http_headers: additionalProperties: items: type: string type: array type: object id: readOnly: true type: string type: enum: - HTTP_HEADER_MATCH type: string type: object description: Condition that checks the event HTTP headers. required: - http_header_names - http_headers - id - type type: object title: HTTP_HEADER_MATCH JavascriptPrehandlerConditionResponse: allOf: - $ref: '#/components/schemas/PrehandlerConditionResponseBase' - properties: id: readOnly: true type: string javascript: type: string type: enum: - JAVASCRIPT_V1 type: string type: object description: >- Condition represented by Javascript. It evaluates to true if the javascript returns true. required: - id - javascript - type type: object title: JAVASCRIPT_V1 PrehandlerActionRequestBase: properties: type: enum: - EXPRESSION - JAVASCRIPT_V1 - MAP_DATA_ATTRIBUTES - SET_DATA - SET_SANDBOX type: string type: object ExpressionInExpressionPrehandlerActionRequest: description: Choose between static or dynamic expression oneOf: - description: Static expression title: Static Value type: object - description: >- Handlebars expression with [PrehandlerActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerActionContext.d.ts). example: handlebars@buildtime:{{expression}} externalDocs: description: PrehandlerActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerActionContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [PrehandlerActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerActionContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('expression');} externalDocs: description: PrehandlerActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerActionContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DataAttributeMapping: properties: attribute: type: string default_value: $ref: '#/components/schemas/DefaultValueInDataAttributeMapping' source_attribute: type: string type: object DataMapInSetDataPrehandlerActionRequest: additionalProperties: $ref: '#/components/schemas/DataInSetDataPrehandlerActionRequest' description: Data to be set to the event. Data names (keys) are not case sensitive. nullable: true type: object Default_dataMapInSetDataPrehandlerActionRequest: additionalProperties: $ref: '#/components/schemas/DefaultDataInSetDataPrehandlerActionRequest' description: >- Default data to be set to the event. Only data (keys) that are not already present in the event will be set. Data names (keys) are not case sensitive. nullable: true type: object PrehandlerConditionRequestBase: properties: type: enum: - BLOCK_MATCH - DATA_EXISTS - EVENT_NAME_MATCH - EXPRESSION - HTTP_HEADER_MATCH - JAVASCRIPT_V1 type: string type: object ExpressionInExpressionPrehandlerConditionRequest: description: Choose between static or dynamic expression oneOf: - description: Static expression title: Static Value type: boolean - description: >- Handlebars expression with [PrehandlerConditionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerConditionContext.d.ts). example: handlebars@buildtime:{{expression}} externalDocs: description: PrehandlerConditionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerConditionContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [PrehandlerConditionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerConditionContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('expression');} externalDocs: description: PrehandlerConditionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerConditionContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string PrehandlerActionResponseBase: properties: id: type: string type: enum: - EXPRESSION - JAVASCRIPT_V1 - MAP_DATA_ATTRIBUTES - SET_DATA - SET_SANDBOX type: string type: object ExpressionInExpressionPrehandlerActionResponse: description: >- The expression as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal expression title: Static Value type: object - description: >- Handlebars expression with [PrehandlerActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerActionContext.d.ts). example: handlebars@buildtime:{{expression}} externalDocs: description: PrehandlerActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerActionContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [PrehandlerActionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerActionContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('expression');} externalDocs: description: PrehandlerActionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerActionContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string PrehandlerConditionResponseBase: properties: id: type: string type: enum: - BLOCK_MATCH - DATA_EXISTS - EVENT_NAME_MATCH - EXPRESSION - HTTP_HEADER_MATCH - JAVASCRIPT_V1 type: string type: object ExpressionInExpressionPrehandlerConditionResponse: description: >- The expression as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - description: Literal expression title: Static Value type: boolean - description: >- Handlebars expression with [PrehandlerConditionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerConditionContext.d.ts). example: handlebars@buildtime:{{expression}} externalDocs: description: PrehandlerConditionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerConditionContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [PrehandlerConditionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerConditionContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('expression');} externalDocs: description: PrehandlerConditionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerConditionContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DefaultValueInDataAttributeMapping: description: Choose between static or dynamic default value oneOf: - allOf: - nullable: true type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static default value title: Static Value - description: >- Handlebars expression with [PrehandlerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerContext.d.ts). example: handlebars@buildtime:{{defaultValue}} externalDocs: description: PrehandlerContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [PrehandlerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('defaultValue');} externalDocs: description: PrehandlerContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DataInSetDataPrehandlerActionRequest: description: Data to be set to the event. Data names (keys) are not case sensitive. oneOf: - allOf: - nullable: true type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static data title: Static Value - description: >- Handlebars expression with [PrehandlerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerContext.d.ts). example: handlebars@buildtime:{{data}} externalDocs: description: PrehandlerContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [PrehandlerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('data');} externalDocs: description: PrehandlerContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string DefaultDataInSetDataPrehandlerActionRequest: description: >- Default data to be set to the event. Only data (keys) that are not already present in the event will be set. Data names (keys) are not case sensitive. oneOf: - allOf: - nullable: true type: string - not: anyOf: - pattern: ^handlebars@buildtime:.* type: string - pattern: ^javascript@buildtime:.* type: string type: string description: Static default data title: Static Value - description: >- Handlebars expression with [PrehandlerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerContext.d.ts). example: handlebars@buildtime:{{defaultData}} externalDocs: description: PrehandlerContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerContext.d.ts pattern: ^handlebars@buildtime:.* title: Buildtime - Handlebars type: string - description: >- Javascript expression with [PrehandlerContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerContext.d.ts). example: >- javascript@buildtime:function() { return context.getVariableContext().get('defaultData');} externalDocs: description: PrehandlerContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/prehandler/PrehandlerContext.d.ts pattern: ^javascript@buildtime:.* title: Buildtime - Javascript type: string examples: prehandler_not_found: summary: prehandler_not_found value: code: prehandler_not_found http_status_code: 400 message: Prehandler not found parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 method_unauthorized: summary: method_unauthorized value: code: method_unauthorized http_status_code: 401 message: Unauthorized access to this endpoint parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 payment_required: summary: payment_required value: code: payment_required http_status_code: 402 message: The access_token provided is associated with an unpaid account. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 access_denied: summary: access_denied value: code: access_denied http_status_code: 403 message: >- The access_token provided is not permitted to access the specified resource. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_access_token: summary: missing_access_token value: code: missing_access_token http_status_code: 403 message: No access_token was provided with this request. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unsupported_media_type: summary: unsupported_media_type value: code: unsupported_media_type http_status_code: 415 message: Request had an unsupported or no media type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 too_many_requests: summary: too_many_requests value: code: too_many_requests http_status_code: 429 message: >- The server is unable to process your request at the moment, please retry later. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 securitySchemes: HEADER: in: header name: Authorization type: apiKey x-bearer-format: bearer QUERY: in: query name: access_token type: apiKey COOKIE: in: cookie name: extole_token type: apiKey ````