Skip to content

AskCustom

AskCustom lets you trigger customer-specific post-processing pipelines. It is the building block for bespoke reports, ERP integrations, or any other workflow that transforms the extracted drawing intelligence into the exact format your organization needs.

Request Parameters

Field Type Required Description
custom_id str Identifier of the custom output to execute. This value is agreed with Werk24 when your pipeline is provisioned.
config dict[str, Any] Arbitrary configuration payload that the post-processor can consume (for example feature toggles or template data). Defaults to an empty object.
postprocessor_slot PostprocessorSlot Route the request to the green or blue post-processing system. When omitted, the default slot for your tenant is used.

Example Usage

from werk24 import AskCustom, Hook, PostprocessorSlot, read_example_drawing

hooks = [
    Hook(
        ask=AskCustom(
            custom_id="my_company_report",
            config={"language": "en"},
            postprocessor_slot=PostprocessorSlot.BLUE,
        ),
        function=print,
    ),
]

read_example_drawing(hooks)

This request runs your custom pipeline against the blue post-processing slot, allowing you to validate upcoming changes without impacting the green production pipeline. Once the new logic is ready, switch the slot to PostprocessorSlot.GREEN or omit the argument to consume your default deployment.

Response

Because AskCustom is tailored to your workflow, the response schema depends on the pipeline that Werk24 configured for you. Consult your integration agreement or contact support to retrieve a sample payload for your tenant.