Event that is triggered when the state of a group changes.
Option 1
Option 2
Option 3
Option 4
Option 5
Show child attributes
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Vatis Tech Documentation","colors":{"primary":"#5EC269","light":"#5EC269","dark":"#5EC269"},"favicon":"/favicon.svg","logo":{"light":"https://mintcdn.com/vatistech/o_HDtapknVDlgLdA/logo/logotype-green-black.svg?fit=max\u0026auto=format\u0026n=o_HDtapknVDlgLdA\u0026q=85\u0026s=32c1d7027a2cbf58f51a9dceb9ab19c0","dark":"https://mintcdn.com/vatistech/o_HDtapknVDlgLdA/logo/logotype-green-white.svg?fit=max\u0026auto=format\u0026n=o_HDtapknVDlgLdA\u0026q=85\u0026s=fb4685604b74e9a0d6aae3d54fd25fde"},"api":{"openapi":["api-reference/openapi/authenticate.json","api-reference/openapi/http-gateway.json","api-reference/openapi/stream-configuration-service.json","api-reference/openapi/stream-service.json","api-reference/openapi/notification-service.json","api-reference/openapi/export-service.json","api-reference/openapi/usage-service.json","api-reference/openapi/egress-service.json","api-reference/openapi/schema-server.json"]},"navbar":{"links":[{"label":"Support","href":"mailto:support@vatis.tech"}],"primary":{"type":"button","label":"Dashboard","href":"https://vatis.tech/app/playground/transcribe"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/vatis-tech","facebook":"https://www.facebook.com/VatisTech","instagram":"https://www.instagram.com/vatis.tech","github":"https://github.com/Vatis-Tech/vatis-streams-samples"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vatistech","hasAudioNarration":false,"actualSubdomain":"vatistech","customDomains":["docs.vatis.tech"],"gitSource":{"type":"github","owner":"vatis-tech","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e62b8d1fcd719df03334","collectionId":"d7190594-ce25-4aca-b53b-e70e391a6292","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21e62b8d1fcd719df03334:success","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API Reference","count":40},{"language":"default","tag":"Documentation","count":25},{"language":"default","tag":"Schemas","count":20},{"language":"default","tag":"Speech to Text","count":11},{"language":"default","tag":"Webhook","count":6},{"language":"default","tag":"Websocket","count":6},{"language":"default","tag":"Webhooks","count":6},{"language":"default","tag":"Infrastructure","count":6},{"language":"default","tag":"Event payload","count":5},{"language":"default","tag":"Streams","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/schemas/webhook/webhook-event","slug":"/api-reference/schemas/webhook/webhook-event","pageMetadata":{"openapi-schema":"WebhookEventDto","title":null,"description":null,"href":"/api-reference/schemas/webhook/webhook-event"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi-schema":"WebhookEventDto","title":null,"description":null,"href":"/api-reference/schemas/webhook/webhook-event"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"schemaData":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the event","uniqueKey":"id","typeLabel":"string"},"type":{"type":"string","description":"Type of the event","uniqueKey":"type","typeLabel":"string"},"webhookEndpointId":{"type":"string","description":"ID of the webhook endpoint that the event is sent to","uniqueKey":"webhookEndpointId","typeLabel":"string"},"timestamp":{"type":"string","description":"Timestamp of the event","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"payloadSchema":{"type":"string","description":"Fully qualified name of the schema of the payload","uniqueKey":"payloadSchema","typeLabel":"string"},"payload":{"oneOf":[{"type":"object","description":"Event that is triggered when the state of a group changes.","properties":{"groupId":{"type":"string","description":"The id of the group that has changed.","format":"uuid","uniqueKey":"payload.oneOf.0.groupId","typeLabel":"string\u003cuuid>"},"state":{"type":"string","description":"The new state of the group. 'COMPLETED' means all streams in the group have been processed successfully, 'FAILED' means all stream in the group finished and at least one stream in the group has failed. A stream can be completed/failed multiple times if new streams are added to the group.","enum":["CREATED","COMPLETED","FAILED","EXPIRED"],"uniqueKey":"payload.oneOf.0.state","typeLabel":"enum\u003cstring>"},"subject":{"type":"string","description":"The subject of the underlying resource","uniqueKey":"payload.oneOf.0.subject","typeLabel":"string"},"dynamicWebhookEndpoints":{"type":"array","description":"List of dynamic webhooks configured for this event","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the webhook endpoint","uniqueKey":"payload.oneOf.0.dynamicWebhookEndpoints.items.[INDEX].id","typeLabel":"string"},"url":{"type":"string","description":"The url of the webhook endpoint","uniqueKey":"payload.oneOf.0.dynamicWebhookEndpoints.items.[INDEX].url","typeLabel":"string"},"events":{"type":"array","description":"The events that the webhook endpoint should be triggered on","items":{"type":"string","uniqueKey":"payload.oneOf.0.dynamicWebhookEndpoints.items.[INDEX].events.items.[INDEX]","typeLabel":"string"},"uniqueKey":"payload.oneOf.0.dynamicWebhookEndpoints.items.[INDEX].events","typeLabel":"string[]"},"enabled":{"type":"boolean","description":"Whether the webhook endpoint is enabled","uniqueKey":"payload.oneOf.0.dynamicWebhookEndpoints.items.[INDEX].enabled","typeLabel":"boolean"},"description":{"type":"string","description":"A description of the webhook endpoint","uniqueKey":"payload.oneOf.0.dynamicWebhookEndpoints.items.[INDEX].description","typeLabel":"string"}},"description":"Object for creating, updating and listing webhook endpoints","uniqueKey":"payload.oneOf.0.dynamicWebhookEndpoints.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payload.oneOf.0.dynamicWebhookEndpoints","typeLabel":"object[]"}},"uniqueKey":"payload.oneOf.0","typeLabel":"object"},{"type":"object","description":"Event emitted when a stream is joined to a group","properties":{"groupId":{"type":"string","description":"The id of the group that has changed.","format":"uuid","uniqueKey":"payload.oneOf.1.groupId","typeLabel":"string\u003cuuid>"},"streamId":{"type":"string","description":"The id of the stream that has been joined to the group.","format":"uuid","uniqueKey":"payload.oneOf.1.streamId","typeLabel":"string\u003cuuid>"},"subject":{"type":"string","description":"The subject of the underlying resource","uniqueKey":"payload.oneOf.1.subject","typeLabel":"string"},"streamSubject":{"type":"string","description":"The subject of the stream","uniqueKey":"payload.oneOf.1.streamSubject","typeLabel":"string"},"dynamicWebhookEndpoints":{"type":"array","description":"List of dynamic webhooks configured for this event","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the webhook endpoint","uniqueKey":"payload.oneOf.1.dynamicWebhookEndpoints.items.[INDEX].id","typeLabel":"string"},"url":{"type":"string","description":"The url of the webhook endpoint","uniqueKey":"payload.oneOf.1.dynamicWebhookEndpoints.items.[INDEX].url","typeLabel":"string"},"events":{"type":"array","description":"The events that the webhook endpoint should be triggered on","items":{"type":"string","uniqueKey":"payload.oneOf.1.dynamicWebhookEndpoints.items.[INDEX].events.items.[INDEX]","typeLabel":"string"},"uniqueKey":"payload.oneOf.1.dynamicWebhookEndpoints.items.[INDEX].events","typeLabel":"string[]"},"enabled":{"type":"boolean","description":"Whether the webhook endpoint is enabled","uniqueKey":"payload.oneOf.1.dynamicWebhookEndpoints.items.[INDEX].enabled","typeLabel":"boolean"},"description":{"type":"string","description":"A description of the webhook endpoint","uniqueKey":"payload.oneOf.1.dynamicWebhookEndpoints.items.[INDEX].description","typeLabel":"string"}},"description":"Object for creating, updating and listing webhook endpoints","uniqueKey":"payload.oneOf.1.dynamicWebhookEndpoints.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payload.oneOf.1.dynamicWebhookEndpoints","typeLabel":"object[]"}},"uniqueKey":"payload.oneOf.1","typeLabel":"object"},{"type":"object","description":"Event regarding changes in the state of a stream gateway","properties":{"streamId":{"type":"string","format":"uuid","uniqueKey":"payload.oneOf.2.streamId","typeLabel":"string\u003cuuid>"},"state":{"type":"string","enum":["CONNECTED","DISCONNECTED","CLOSED","ERROR"],"uniqueKey":"payload.oneOf.2.state","typeLabel":"enum\u003cstring>"},"gatewayHost":{"type":"string","description":"The updated host of the gateway","uniqueKey":"payload.oneOf.2.gatewayHost","typeLabel":"string"},"subject":{"type":"string","description":"Owner of the resource this event relates to","uniqueKey":"payload.oneOf.2.subject","typeLabel":"string"},"details":{"type":"string","description":"Optional details about the state change","uniqueKey":"payload.oneOf.2.details","typeLabel":"string"}},"uniqueKey":"payload.oneOf.2","typeLabel":"object"},{"type":"object","description":"Event regarding the state of a stream processor","properties":{"streamId":{"type":"string","format":"uuid","uniqueKey":"payload.oneOf.3.streamId","typeLabel":"string\u003cuuid>"},"processorConfigurationId":{"type":"string","description":"Processor id as defined in the declaration","uniqueKey":"payload.oneOf.3.processorConfigurationId","typeLabel":"string"},"state":{"type":"string","description":"The new state of the processor","enum":["RUNNING","COMPLETED","WAITING","ERROR","CLOSED"],"uniqueKey":"payload.oneOf.3.state","typeLabel":"enum\u003cstring>"},"details":{"type":"string","description":"Optional details about the state change","uniqueKey":"payload.oneOf.3.details","typeLabel":"string"},"subject":{"type":"string","description":"Owner of the resource this event relates to","uniqueKey":"payload.oneOf.3.subject","typeLabel":"string"}},"uniqueKey":"payload.oneOf.3","typeLabel":"object"},{"type":"object","description":"Event regarding stream state changed","properties":{"streamId":{"type":"string","format":"uuid","uniqueKey":"payload.oneOf.4.streamId","typeLabel":"string\u003cuuid>"},"groupId":{"type":"string","description":"Group id of the stream","format":"uuid","uniqueKey":"payload.oneOf.4.groupId","typeLabel":"string\u003cuuid>"},"state":{"type":"string","enum":["READY","COMPLETED","FAILED","EXPIRED"],"uniqueKey":"payload.oneOf.4.state","typeLabel":"enum\u003cstring>"},"subject":{"type":"string","description":"Owner of the resource this event relates to","uniqueKey":"payload.oneOf.4.subject","typeLabel":"string"},"stream":{"type":"object","properties":{"streamId":{"type":"string","description":"Stream id. It can be either auto-generated or specified by the user","format":"uuid","uniqueKey":"payload.oneOf.4.stream.streamId","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Arbitrary name of the stream","uniqueKey":"payload.oneOf.4.stream.name","typeLabel":"string"},"groupId":{"type":"string","description":"The id of the streams group","format":"uuid","uniqueKey":"payload.oneOf.4.stream.groupId","typeLabel":"string\u003cuuid>"},"configuration":{"type":"object","properties":{"streamConfigurationTemplateId":{"type":"string","description":"The ID of the underlying stream configuration template","uniqueKey":"payload.oneOf.4.stream.configuration.streamConfigurationTemplateId","typeLabel":"string"},"dataSource":{"type":"object","properties":{"topic":{"type":"string","description":"Fully qualified topic name (including tenant, namespace etc.)","uniqueKey":"payload.oneOf.4.stream.configuration.dataSource.topic","typeLabel":"string"},"messageSchema":{"type":"string","description":"Fully qualified schema name","uniqueKey":"payload.oneOf.4.stream.configuration.dataSource.messageSchema","typeLabel":"string"},"connectionOptions":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payload.oneOf.4.stream.configuration.dataSource.connectionOptions.additionalProperties","typeLabel":"string"},"description":"Properties for connecting to the topic","uniqueKey":"payload.oneOf.4.stream.configuration.dataSource.connectionOptions","typeLabel":"object"},"headers":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payload.oneOf.4.stream.configuration.dataSource.headers.additionalProperties","typeLabel":"string"},"description":"Topic headers","uniqueKey":"payload.oneOf.4.stream.configuration.dataSource.headers","typeLabel":"object"},"messageHeaders":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payload.oneOf.4.stream.configuration.dataSource.messageHeaders.additionalProperties","typeLabel":"string"},"description":"Headers to be applied on all messages sent to this topic","uniqueKey":"payload.oneOf.4.stream.configuration.dataSource.messageHeaders","typeLabel":"object"},"subscriptions":{"type":"object","additionalProperties":{"type":"object","properties":{"subscription":{"type":"string","description":"The subscription name","uniqueKey":"payload.oneOf.4.stream.configuration.dataSource.subscriptions.additionalProperties.subscription","typeLabel":"string"},"topic":{"type":"string","description":"Fully qualified topic name (including tenant, namespace)","uniqueKey":"payload.oneOf.4.stream.configuration.dataSource.subscriptions.additionalProperties.topic","typeLabel":"string"},"messageSchema":{"type":"string","description":"Fully qualified schema name","uniqueKey":"payload.oneOf.4.stream.configuration.dataSource.subscriptions.additionalProperties.messageSchema","typeLabel":"string"},"connectionOptions":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payload.oneOf.4.stream.configuration.dataSource.subscriptions.additionalProperties.connectionOptions.additionalProperties","typeLabel":"string"},"description":"Properties for connecting to the subscription","uniqueKey":"payload.oneOf.4.stream.configuration.dataSource.subscriptions.additionalProperties.connectionOptions","typeLabel":"object"},"headers":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payload.oneOf.4.stream.configuration.dataSource.subscriptions.additionalProperties.headers.additionalProperties","typeLabel":"string"},"description":"Subscription headers. Pattern: X-Vat-Sub-[a-zA-Z0-9\\-]+$","uniqueKey":"payload.oneOf.4.stream.configuration.dataSource.subscriptions.additionalProperties.headers","typeLabel":"object"}},"description":"Information regarding a subscription to a topic","uniqueKey":"payload.oneOf.4.stream.configuration.dataSource.subscriptions.additionalProperties","typeLabel":"object"},"description":"Map of component name and subscription associations","uniqueKey":"payload.oneOf.4.stream.configuration.dataSource.subscriptions","typeLabel":"object"}},"description":"Required information for connecting to a topic","uniqueKey":"payload.oneOf.4.stream.configuration.dataSource","typeLabel":"object"},"dataSinks":{"type":"object","additionalProperties":{"type":"object","properties":{"topic":{"type":"string","description":"Fully qualified topic name (including tenant, namespace etc.)","uniqueKey":"payload.oneOf.4.stream.configuration.dataSinks.additionalProperties.topic","typeLabel":"string"},"messageSchema":{"type":"string","description":"Fully qualified schema name","uniqueKey":"payload.oneOf.4.stream.configuration.dataSinks.additionalProperties.messageSchema","typeLabel":"string"},"connectionOptions":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payload.oneOf.4.stream.configuration.dataSinks.additionalProperties.connectionOptions.additionalProperties","typeLabel":"string"},"description":"Properties for connecting to the topic","uniqueKey":"payload.oneOf.4.stream.configuration.dataSinks.additionalProperties.connectionOptions","typeLabel":"object"},"headers":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payload.oneOf.4.stream.configuration.dataSinks.additionalProperties.headers.additionalProperties","typeLabel":"string"},"description":"Topic headers","uniqueKey":"payload.oneOf.4.stream.configuration.dataSinks.additionalProperties.headers","typeLabel":"object"},"messageHeaders":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payload.oneOf.4.stream.configuration.dataSinks.additionalProperties.messageHeaders.additionalProperties","typeLabel":"string"},"description":"Headers to be applied on all messages sent to this topic","uniqueKey":"payload.oneOf.4.stream.configuration.dataSinks.additionalProperties.messageHeaders","typeLabel":"object"},"subscriptions":{"type":"object","additionalProperties":{"type":"object","properties":{"subscription":{"type":"string","description":"The subscription name","uniqueKey":"payload.oneOf.4.stream.configuration.dataSinks.additionalProperties.subscriptions.additionalProperties.subscription","typeLabel":"string"},"topic":{"type":"string","description":"Fully qualified topic name (including tenant, namespace)","uniqueKey":"payload.oneOf.4.stream.configuration.dataSinks.additionalProperties.subscriptions.additionalProperties.topic","typeLabel":"string"},"messageSchema":{"type":"string","description":"Fully qualified schema name","uniqueKey":"payload.oneOf.4.stream.configuration.dataSinks.additionalProperties.subscriptions.additionalProperties.messageSchema","typeLabel":"string"},"connectionOptions":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payload.oneOf.4.stream.configuration.dataSinks.additionalProperties.subscriptions.additionalProperties.connectionOptions.additionalProperties","typeLabel":"string"},"description":"Properties for connecting to the subscription","uniqueKey":"payload.oneOf.4.stream.configuration.dataSinks.additionalProperties.subscriptions.additionalProperties.connectionOptions","typeLabel":"object"},"headers":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payload.oneOf.4.stream.configuration.dataSinks.additionalProperties.subscriptions.additionalProperties.headers.additionalProperties","typeLabel":"string"},"description":"Subscription headers. Pattern: X-Vat-Sub-[a-zA-Z0-9\\-]+$","uniqueKey":"payload.oneOf.4.stream.configuration.dataSinks.additionalProperties.subscriptions.additionalProperties.headers","typeLabel":"object"}},"description":"Information regarding a subscription to a topic","uniqueKey":"payload.oneOf.4.stream.configuration.dataSinks.additionalProperties.subscriptions.additionalProperties","typeLabel":"object"},"description":"Map of component name and subscription associations","uniqueKey":"payload.oneOf.4.stream.configuration.dataSinks.additionalProperties.subscriptions","typeLabel":"object"}},"description":"Required information for connecting to a topic","uniqueKey":"payload.oneOf.4.stream.configuration.dataSinks.additionalProperties","typeLabel":"object"},"description":"Association of processor id and corresponding sink topic. Only the processor with a sink destination are present.","uniqueKey":"payload.oneOf.4.stream.configuration.dataSinks","typeLabel":"object"},"processors":{"type":"array","description":"Configurations array of stream processors objects","items":{"type":"object","properties":{"id":{"type":"string","description":"Auto-generated id of the configuration","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].id","typeLabel":"string"},"source":{"type":"object","properties":{"subscription":{"type":"string","description":"The subscription name","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].source.subscription","typeLabel":"string"},"topic":{"type":"string","description":"Fully qualified topic name (including tenant, namespace)","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].source.topic","typeLabel":"string"},"messageSchema":{"type":"string","description":"Fully qualified schema name","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].source.messageSchema","typeLabel":"string"},"connectionOptions":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].source.connectionOptions.additionalProperties","typeLabel":"string"},"description":"Properties for connecting to the subscription","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].source.connectionOptions","typeLabel":"object"},"headers":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].source.headers.additionalProperties","typeLabel":"string"},"description":"Subscription headers. Pattern: X-Vat-Sub-[a-zA-Z0-9\\-]+$","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].source.headers","typeLabel":"object"}},"description":"Information regarding a subscription to a topic","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].source","typeLabel":"object"},"destination":{"type":"object","properties":{"topic":{"type":"string","description":"Fully qualified topic name (including tenant, namespace etc.)","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].destination.topic","typeLabel":"string"},"messageSchema":{"type":"string","description":"Fully qualified schema name","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].destination.messageSchema","typeLabel":"string"},"connectionOptions":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].destination.connectionOptions.additionalProperties","typeLabel":"string"},"description":"Properties for connecting to the topic","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].destination.connectionOptions","typeLabel":"object"},"headers":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].destination.headers.additionalProperties","typeLabel":"string"},"description":"Topic headers","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].destination.headers","typeLabel":"object"},"messageHeaders":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].destination.messageHeaders.additionalProperties","typeLabel":"string"},"description":"Headers to be applied on all messages sent to this topic","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].destination.messageHeaders","typeLabel":"object"},"subscriptions":{"type":"object","additionalProperties":{"type":"object","properties":{"subscription":{"type":"string","description":"The subscription name","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].destination.subscriptions.additionalProperties.subscription","typeLabel":"string"},"topic":{"type":"string","description":"Fully qualified topic name (including tenant, namespace)","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].destination.subscriptions.additionalProperties.topic","typeLabel":"string"},"messageSchema":{"type":"string","description":"Fully qualified schema name","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].destination.subscriptions.additionalProperties.messageSchema","typeLabel":"string"},"connectionOptions":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].destination.subscriptions.additionalProperties.connectionOptions.additionalProperties","typeLabel":"string"},"description":"Properties for connecting to the subscription","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].destination.subscriptions.additionalProperties.connectionOptions","typeLabel":"object"},"headers":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].destination.subscriptions.additionalProperties.headers.additionalProperties","typeLabel":"string"},"description":"Subscription headers. Pattern: X-Vat-Sub-[a-zA-Z0-9\\-]+$","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].destination.subscriptions.additionalProperties.headers","typeLabel":"object"}},"description":"Information regarding a subscription to a topic","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].destination.subscriptions.additionalProperties","typeLabel":"object"},"description":"Map of component name and subscription associations","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].destination.subscriptions","typeLabel":"object"}},"description":"Required information for connecting to a topic","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].destination","typeLabel":"object"},"clusterDomainName":{"type":"string","description":"The internal DNS of the processor pod (e.g. my-statefulset-0.svc.cluster.local)","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].clusterDomainName","typeLabel":"string"},"podsDiscoveryClusterDomainName":{"type":"string","description":"Internal DNS of the headless service that exposes the pods (e.g. headless-service.default.svc.cluster.local)","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].podsDiscoveryClusterDomainName","typeLabel":"string"},"propertiesSchema":{"type":"string","description":"Fully qualified name of AVRO schema for processor properties","enum":["tech.vatis.schema.stream.processor.properties.transcoder.TranscoderProcessorPropertiesDto","tech.vatis.schema.stream.processor.properties.whispergpu.WhisperGpuProcessorPropertiesDto","tech.vatis.schema.stream.processor.properties.vad.VoiceActivityDetectorPropertiesDto","tech.vatis.schema.stream.processor.properties.fasterwhisper.FasterWhisperProcessorPropertiesDto","tech.vatis.schema.stream.processor.properties.pyannote.PyAnnoteProcessorPropertiesDto","tech.vatis.schema.stream.processor.properties.liveasr.LiveAsrProcessorPropertiesDto","tech.vatis.schema.stream.processor.properties.llm.LlmPropertiesDto","tech.vatis.schema.stream.processor.properties.NoPropertiesDto"],"uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].propertiesSchema","typeLabel":"enum\u003cstring>"},"properties":{"oneOf":[{"type":"object","description":"Processor properties","properties":{"inputFormat":{"type":"string","description":"Media input format. If null, it'll be auto-detected","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.0.inputFormat","typeLabel":"string"},"outputFormat":{"type":"string","description":"Media output format","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.0.outputFormat","typeLabel":"string"},"outputBufferSize":{"type":"integer","description":"Output buffer size in bytes. This represents the size of the output packets","format":"int64","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.0.outputBufferSize","typeLabel":"integer\u003cint64>"},"commandArguments":{"type":"array","description":"Arguments used for the transcoding command","items":{"type":"object","properties":{"argument":{"type":"string","description":"Argument","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.0.commandArguments.items.[INDEX].argument","typeLabel":"string"},"value":{"type":"string","description":"Value","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.0.commandArguments.items.[INDEX].value","typeLabel":"string"}},"description":"Command-line argument for FFmpeg or FFprobe","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.0.commandArguments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.0.commandArguments","typeLabel":"object[]"},"ffprobe":{"type":"object","properties":{"probeSize":{"type":"string","description":"Number of bytes to probe from the input stream. Null defaults to processor default","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.0.ffprobe.probeSize","typeLabel":"string"},"analyzeDuration":{"type":"string","description":"Duration in microseconds to probe from the input stream. Null defaults to processor default","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.0.ffprobe.analyzeDuration","typeLabel":"string"},"commandArguments":{"type":"array","description":"Arguments used for the probing command","items":{"type":"object","properties":{"argument":{"type":"string","description":"Argument","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.0.ffprobe.commandArguments.items.[INDEX].argument","typeLabel":"string"},"value":{"type":"string","description":"Value","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.0.ffprobe.commandArguments.items.[INDEX].value","typeLabel":"string"}},"description":"Command-line argument for FFmpeg or FFprobe","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.0.ffprobe.commandArguments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.0.ffprobe.commandArguments","typeLabel":"object[]"}},"description":"Properties for probing the input. The probing ends when either of its specified limits is reached","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.0.ffprobe","typeLabel":"object"},"mode":{"type":"integer","description":"Transcoding mode. 0: streaming, 1: file, null: auto-detect. File mode is used for transcoding media type that require re-reading the input data. This comes with an increased latency making it not suitable for live streaming, and limitation of upload size","format":"int32","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.0.mode","typeLabel":"integer\u003cint32>"}},"uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.0","typeLabel":"object"},{"type":"object","description":"Properties for the Whisper GPU processor","properties":{"language":{"type":"string","description":"The language of the Whisper GPU processor. Default is None, meaning auto-detect. When specified, this will be the preferred or enforced language. The format is a 2-charater ISO 639-1 language code.","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.1.language","typeLabel":"string"},"allowedLanguages":{"type":"array","description":"The list of languages that the Whisper GPU processor is allowed to use. When the preferred language is specified, it will be used as much as possible. Otherwise, only languages from this list will be used by the highest confidence. The format is a 2-charater ISO 639-1 language code.","items":{"type":"string","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.1.allowedLanguages.items.[INDEX]","typeLabel":"string"},"uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.1.allowedLanguages","typeLabel":"string[]"},"includeWords":{"type":"boolean","description":"Whether to include words in the output","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.1.includeWords","typeLabel":"boolean"}},"uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.1","typeLabel":"object"},{"type":"object","description":"Voice Activity Detector properties","properties":{"speechThreshold":{"type":"number","description":"Confidence threshold for speech detection","format":"float","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.2.speechThreshold","typeLabel":"number\u003cfloat>"},"minimumSpeechDurationMillis":{"type":"integer","description":"Minimum duration of voice activity in milliseconds to be considered as speech","format":"int32","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.2.minimumSpeechDurationMillis","typeLabel":"integer\u003cint32>"},"minimumSilenceDurationMillis":{"type":"integer","description":"Minimum duration of trailing silence in milliseconds needed to filter out the packet","format":"int32","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.2.minimumSilenceDurationMillis","typeLabel":"integer\u003cint32>"},"forwardNoSpeechFrames":{"type":"boolean","description":"Forward frames with no speech detected","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.2.forwardNoSpeechFrames","typeLabel":"boolean"},"includeAudioPayload":{"type":"boolean","description":"Include audio payload in the output","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.2.includeAudioPayload","typeLabel":"boolean"},"includeVoiceActivityRanges":{"type":"boolean","description":"Include voice activity ranges header with details ranges of detected speech activity","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.2.includeVoiceActivityRanges","typeLabel":"boolean"}},"uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.2","typeLabel":"object"},{"type":"object","description":"Properties for FasterWhisperProcessor","properties":{"vad":{"type":"boolean","description":"Enable Voice Activity Detection (VAD) for eliminating silent parts of the audio stream","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.3.vad","typeLabel":"boolean"},"noSpeechThreshold":{"type":"number","description":"Threshold for VAD to consider a frame as silent","format":"double","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.3.noSpeechThreshold","typeLabel":"number\u003cdouble>"},"language":{"type":"string","description":"Language ISO code (e.g. 'en', 'ro') of the audio stream. If null, it will be auto-detected","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.3.language","typeLabel":"string"},"splitStereo":{"type":"boolean","description":"Split stereo audio into two mono audio to be transcribed separately","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.3.splitStereo","typeLabel":"boolean"},"allowedLanguages":{"type":"array","description":"Specify a list of allowed languages to limit the language auto-detection possibilities. If null, all languages are allowed. Both 'language' and 'allowedLanguages' are specified, the 'language' will be appended to the 'allowedLanguages'","items":{"type":"string","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.3.allowedLanguages.items.[INDEX]","typeLabel":"string"},"uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.3.allowedLanguages","typeLabel":"string[]"}},"uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.3","typeLabel":"object"},{"type":"object","description":"Properties for PyAnnote processor","properties":{"speakersNumber":{"type":"integer","description":"Number of speakers","format":"int32","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.4.speakersNumber","typeLabel":"integer\u003cint32>"},"minSpeakersNumber":{"type":"integer","description":"Minimum number of speakers","format":"int32","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.4.minSpeakersNumber","typeLabel":"integer\u003cint32>"},"maxSpeakersNumber":{"type":"integer","description":"Maximum number of speakers","format":"int32","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.4.maxSpeakersNumber","typeLabel":"integer\u003cint32>"}},"uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.4","typeLabel":"object"},{"type":"object","description":"Properties for Live ASR processor","properties":{"language":{"type":"string","description":"Audio language. If not specified, defaults to processors default language (generally 'en')","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.5.language","typeLabel":"string"},"modelOption":{"type":"string","description":"Model option to use for ASR","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.5.modelOption","typeLabel":"string"},"multichannel":{"type":"boolean","description":"Whether to use multichannel audio processing","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.5.multichannel","typeLabel":"boolean"},"finalFrameStrategy":{"type":"string","description":"Strategy to use for determining final frame. Accepted values are: 'transcription' - when the transcription cannot be improved any further, 'utterance' - when a utterance has semantically ended","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.5.finalFrameStrategy","typeLabel":"string"},"utteranceEndSilence":{"type":"integer","description":"Silence duration in milliseconds to consider as end of utterance. Used only when finalFrameStrategy is 'utterance'","format":"int64","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.5.utteranceEndSilence","typeLabel":"integer\u003cint64>"},"encoding":{"type":"string","description":"Audio encoding. Required only when sending not containerized audio data. Possible values are: linear16, flac, mulaw, opus","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.5.encoding","typeLabel":"string"},"sampleRate":{"type":"integer","description":"Audio sample rate. Required only when sending not containerized audio data","format":"int32","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.5.sampleRate","typeLabel":"integer\u003cint32>"},"channels":{"type":"integer","description":"Number of audio channels. Required only when sending not containerized audio data","format":"int32","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.5.channels","typeLabel":"integer\u003cint32>"}},"uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.5","typeLabel":"object"},{"type":"object","description":"Configuration properties for the LLM processor","properties":{"summary":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether to enable the prompt or not. If it is not enabled, the prompt will not be processed.","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.summary.enabled","typeLabel":"boolean"},"flushInterval":{"type":"integer","description":"Accumulate response and flush it after the given interval in milliseconds. The message may be sent earlier if it exceeds a defined size limit. The message may be also sent later if the required context to produce the response is not available.","format":"int64","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.summary.flushInterval","typeLabel":"integer\u003cint64>"},"properties":{"type":"object","additionalProperties":{"type":"object","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.summary.properties.additionalProperties","typeLabel":"object"},"description":"Content placeholders. The key is the placeholder name and the value is the placeholder value","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.summary.properties","typeLabel":"object"}},"description":"Prompt configuration","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.summary","typeLabel":"object"},"sentimentAnalysis":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether to enable the prompt or not. If it is not enabled, the prompt will not be processed.","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.sentimentAnalysis.enabled","typeLabel":"boolean"},"flushInterval":{"type":"integer","description":"Accumulate response and flush it after the given interval in milliseconds. The message may be sent earlier if it exceeds a defined size limit. The message may be also sent later if the required context to produce the response is not available.","format":"int64","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.sentimentAnalysis.flushInterval","typeLabel":"integer\u003cint64>"},"properties":{"type":"object","additionalProperties":{"type":"object","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.sentimentAnalysis.properties.additionalProperties","typeLabel":"object"},"description":"Content placeholders. The key is the placeholder name and the value is the placeholder value","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.sentimentAnalysis.properties","typeLabel":"object"}},"description":"Prompt configuration","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.sentimentAnalysis","typeLabel":"object"},"topicDetection":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether to enable the prompt or not. If it is not enabled, the prompt will not be processed.","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.topicDetection.enabled","typeLabel":"boolean"},"flushInterval":{"type":"integer","description":"Accumulate response and flush it after the given interval in milliseconds. The message may be sent earlier if it exceeds a defined size limit. The message may be also sent later if the required context to produce the response is not available.","format":"int64","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.topicDetection.flushInterval","typeLabel":"integer\u003cint64>"},"properties":{"type":"object","additionalProperties":{"type":"object","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.topicDetection.properties.additionalProperties","typeLabel":"object"},"description":"Content placeholders. The key is the placeholder name and the value is the placeholder value","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.topicDetection.properties","typeLabel":"object"}},"description":"Prompt configuration","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.topicDetection","typeLabel":"object"},"autoChapter":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether to enable the prompt or not. If it is not enabled, the prompt will not be processed.","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.autoChapter.enabled","typeLabel":"boolean"},"flushInterval":{"type":"integer","description":"Accumulate response and flush it after the given interval in milliseconds. The message may be sent earlier if it exceeds a defined size limit. The message may be also sent later if the required context to produce the response is not available.","format":"int64","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.autoChapter.flushInterval","typeLabel":"integer\u003cint64>"},"properties":{"type":"object","additionalProperties":{"type":"object","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.autoChapter.properties.additionalProperties","typeLabel":"object"},"description":"Content placeholders. The key is the placeholder name and the value is the placeholder value","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.autoChapter.properties","typeLabel":"object"}},"description":"Prompt configuration","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.autoChapter","typeLabel":"object"},"intentDetection":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether to enable the prompt or not. If it is not enabled, the prompt will not be processed.","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.intentDetection.enabled","typeLabel":"boolean"},"flushInterval":{"type":"integer","description":"Accumulate response and flush it after the given interval in milliseconds. The message may be sent earlier if it exceeds a defined size limit. The message may be also sent later if the required context to produce the response is not available.","format":"int64","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.intentDetection.flushInterval","typeLabel":"integer\u003cint64>"},"properties":{"type":"object","additionalProperties":{"type":"object","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.intentDetection.properties.additionalProperties","typeLabel":"object"},"description":"Content placeholders. The key is the placeholder name and the value is the placeholder value","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.intentDetection.properties","typeLabel":"object"}},"description":"Prompt configuration","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.intentDetection","typeLabel":"object"},"askAnything":{"type":"array","description":"List of custom ask-anything prompts to be used in the LLM processor. The generated promptId will be the index of the prompt in the list, if not explicitly set.","items":{"type":"object","properties":{"promptId":{"type":"string","description":"Prompt ID, having up to 64 characters. Null will generate a random ID","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.askAnything.items.[INDEX].promptId","typeLabel":"string"},"enabled":{"type":"boolean","description":"Whether to enable the prompt or not. If it is not enabled, or the content is null, the prompt will not be processed.","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.askAnything.items.[INDEX].enabled","typeLabel":"boolean"},"flushInterval":{"type":"integer","description":"Accumulate response and flush it after the given interval in milliseconds. The message may be sent earlier if it exceeds a defined size limit. The message may be also sent later if the required context to produce the response is not available.","format":"int64","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.askAnything.items.[INDEX].flushInterval","typeLabel":"integer\u003cint64>"},"responseFormat":{"type":"object","properties":{"specification":{"type":"string","description":"Json Schema specification as defined here: https://json-schema.org/draft/2020-12/release-notes","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.askAnything.items.[INDEX].responseFormat.specification","typeLabel":"string"},"strict":{"type":"boolean","description":"If the 'strict' mode is enabled and the input data does not match the schema or the schema is invalid, the processor will throw an exception","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.askAnything.items.[INDEX].responseFormat.strict","typeLabel":"boolean"},"includeInResponse":{"type":"boolean","description":"If the 'includeInResponse' mode is enabled, the processor will include the schema in the LLM response. This is useful when multiple prompts are specified.","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.askAnything.items.[INDEX].responseFormat.includeInResponse","typeLabel":"boolean"}},"description":"Output schema for LLM processor responses","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.askAnything.items.[INDEX].responseFormat","typeLabel":"object"},"content":{"type":"string","description":"Prompt content in the context of the upstream results. When null, the prompt is always disabled. It allows template placeholders using the format '{placeholderName}'","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.askAnything.items.[INDEX].content","typeLabel":"string"},"properties":{"type":"object","additionalProperties":{"type":"object","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.askAnything.items.[INDEX].properties.additionalProperties","typeLabel":"object"},"description":"Content placeholders. The key is the placeholder name and the value is the placeholder value","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.askAnything.items.[INDEX].properties","typeLabel":"object"},"systemPrompt":{"type":"string","description":"System prompt. It allows template placeholders using the format '{placeholderName}'","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.askAnything.items.[INDEX].systemPrompt","typeLabel":"string"},"systemPromptProperties":{"type":"object","additionalProperties":{"type":"object","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.askAnything.items.[INDEX].systemPromptProperties.additionalProperties","typeLabel":"object"},"description":"System prompt placeholders. The key is the placeholder name and the value is the placeholder value","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.askAnything.items.[INDEX].systemPromptProperties","typeLabel":"object"}},"description":"Prompt configuration","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.askAnything.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.askAnything","typeLabel":"object[]"},"transcriptionEnhancement":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether to enable the prompt or not. If it is not enabled, the prompt will not be processed.","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.transcriptionEnhancement.enabled","typeLabel":"boolean"},"systemPrompt":{"type":"string","description":"The system prompt to be used for the transcription enhancement. This is a fixed prompt that provides context to the LLM.","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.transcriptionEnhancement.systemPrompt","typeLabel":"string"},"vocabulary":{"type":"array","description":"Set of words to focus the enhancement around. Those generally are domain-specific terms or keywords that should be emphasized in the transcription.","items":{"type":"string","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.transcriptionEnhancement.vocabulary.items.[INDEX]","typeLabel":"string"},"uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.transcriptionEnhancement.vocabulary","typeLabel":"string[]"},"model":{"type":"string","description":"The model to be used for the transcription enhancement. Use this option to adjust the accuracy-speed ratio","enum":["standard","enhanced"],"uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.transcriptionEnhancement.model","typeLabel":"enum\u003cstring>"},"spellings":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.transcriptionEnhancement.spellings.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.transcriptionEnhancement.spellings.additionalProperties","typeLabel":"string[]"},"description":"Map of words to their possible spellings. This is used to improve the accuracy of the transcription by providing alternative spellings for certain words.","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.transcriptionEnhancement.spellings","typeLabel":"object"}},"description":"Properties for the transcription enhancement prompt.","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6.transcriptionEnhancement","typeLabel":"object"}},"uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.6","typeLabel":"object"},{"type":"object","description":"Placeholder for no properties","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties.oneOf.7","typeLabel":"object"}],"uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].properties","typeLabel":"object"},"egress":{"type":"object","properties":{"persist":{"type":"boolean","description":"Whether to persist the results of the processor. Only final results will be persisted.","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].egress.persist","typeLabel":"boolean"},"sink":{"type":"boolean","description":"Mark this processor as sink to capture the output. By default, all leaf processors are sinks.","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].egress.sink","typeLabel":"boolean"},"tags":{"type":"array","description":"Tags of the sink. Only used when sink is true. Tags can be used to select the sinks. By default, all sink processors will have the processor id as a tag, and each leaf processor will additionally have the 'main' tag. They must respect the pattern '^[a-zA-Z0-9_.-]+$' and be up to 255 characters long. The maximum number of tags is 10.","items":{"type":"string","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].egress.tags.items.[INDEX]","typeLabel":"string"},"uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].egress.tags","typeLabel":"string[]"}},"description":"Configuration for persisting and filtering the results of a processor","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX].egress","typeLabel":"object"}},"description":"Configuration object of a stream processor","uniqueKey":"payload.oneOf.4.stream.configuration.processors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payload.oneOf.4.stream.configuration.processors","typeLabel":"object[]"},"dynamicWebhookEndpoints":{"type":"array","description":"List of configured dynamic webhooks.","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the webhook endpoint","uniqueKey":"payload.oneOf.4.stream.configuration.dynamicWebhookEndpoints.items.[INDEX].id","typeLabel":"string"},"url":{"type":"string","description":"The url of the webhook endpoint","uniqueKey":"payload.oneOf.4.stream.configuration.dynamicWebhookEndpoints.items.[INDEX].url","typeLabel":"string"},"events":{"type":"array","description":"The events that the webhook endpoint should be triggered on","items":{"type":"string","uniqueKey":"payload.oneOf.4.stream.configuration.dynamicWebhookEndpoints.items.[INDEX].events.items.[INDEX]","typeLabel":"string"},"uniqueKey":"payload.oneOf.4.stream.configuration.dynamicWebhookEndpoints.items.[INDEX].events","typeLabel":"string[]"},"enabled":{"type":"boolean","description":"Whether the webhook endpoint is enabled","uniqueKey":"payload.oneOf.4.stream.configuration.dynamicWebhookEndpoints.items.[INDEX].enabled","typeLabel":"boolean"},"description":{"type":"string","description":"A description of the webhook endpoint","uniqueKey":"payload.oneOf.4.stream.configuration.dynamicWebhookEndpoints.items.[INDEX].description","typeLabel":"string"}},"description":"Object for creating, updating and listing webhook endpoints","uniqueKey":"payload.oneOf.4.stream.configuration.dynamicWebhookEndpoints.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payload.oneOf.4.stream.configuration.dynamicWebhookEndpoints","typeLabel":"object[]"}},"description":"Configuration object of a stream","uniqueKey":"payload.oneOf.4.stream.configuration","typeLabel":"object"},"createdTimestamp":{"type":"string","format":"date-time","uniqueKey":"payload.oneOf.4.stream.createdTimestamp","typeLabel":"string\u003cdate-time>"},"creatorId":{"type":"string","description":"Id of the user that created this stream","uniqueKey":"payload.oneOf.4.stream.creatorId","typeLabel":"string"},"groupCreatorId":{"type":"string","description":"Id of the user that created the group of this stream. This should save round-trips to stream-service for access control checks","uniqueKey":"payload.oneOf.4.stream.groupCreatorId","typeLabel":"string"},"state":{"type":"string","description":"Stream's state","enum":["READY","COMPLETED","FAILED","EXPIRED"],"uniqueKey":"payload.oneOf.4.stream.state","typeLabel":"enum\u003cstring>"},"stateDescription":{"type":"string","description":"Description of the current stream state, most probably the error details","uniqueKey":"payload.oneOf.4.stream.stateDescription","typeLabel":"string"},"finalizedTimestamp":{"type":"string","description":"Timestamp when the stream was finalized","format":"date-time","uniqueKey":"payload.oneOf.4.stream.finalizedTimestamp","typeLabel":"string\u003cdate-time>"}},"description":"Stream object representing the current state of the stream","uniqueKey":"payload.oneOf.4.stream","typeLabel":"object"},"dynamicWebhookEndpoints":{"type":"array","description":"List of dynamic webhooks configured for this event","items":{"type":"object","properties":{"id":{"type":"string","description":"The id of the webhook endpoint","uniqueKey":"payload.oneOf.4.dynamicWebhookEndpoints.items.[INDEX].id","typeLabel":"string"},"url":{"type":"string","description":"The url of the webhook endpoint","uniqueKey":"payload.oneOf.4.dynamicWebhookEndpoints.items.[INDEX].url","typeLabel":"string"},"events":{"type":"array","description":"The events that the webhook endpoint should be triggered on","items":{"type":"string","uniqueKey":"payload.oneOf.4.dynamicWebhookEndpoints.items.[INDEX].events.items.[INDEX]","typeLabel":"string"},"uniqueKey":"payload.oneOf.4.dynamicWebhookEndpoints.items.[INDEX].events","typeLabel":"string[]"},"enabled":{"type":"boolean","description":"Whether the webhook endpoint is enabled","uniqueKey":"payload.oneOf.4.dynamicWebhookEndpoints.items.[INDEX].enabled","typeLabel":"boolean"},"description":{"type":"string","description":"A description of the webhook endpoint","uniqueKey":"payload.oneOf.4.dynamicWebhookEndpoints.items.[INDEX].description","typeLabel":"string"}},"description":"Object for creating, updating and listing webhook endpoints","uniqueKey":"payload.oneOf.4.dynamicWebhookEndpoints.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payload.oneOf.4.dynamicWebhookEndpoints","typeLabel":"object[]"}},"uniqueKey":"payload.oneOf.4","typeLabel":"object"}],"uniqueKey":"payload","typeLabel":"object"}},"description":"Webhook event sent to the target webhook endpoint","uniqueKey":"","typeLabel":"object","example":{"title":"Example","value":{"id":"\u003cstring>","type":"\u003cstring>","webhookEndpointId":"\u003cstring>","timestamp":"2023-11-07T05:31:56Z","payloadSchema":"\u003cstring>","payload":{"groupId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","subject":"\u003cstring>","dynamicWebhookEndpoints":[{"id":"\u003cstring>","url":"\u003cstring>","events":["\u003cstring>"],"enabled":true,"description":"\u003cstring>"}]}}}},"originalFileLocation":"api-reference/openapi/schema-server.json"},"subdomain":"vatistech","siteName":"Vatis Tech Documentation","title":"Webhook event - Vatis Tech Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-09-15T09:59:50.552Z","originalFileLocation":"api-reference/schemas/webhook/webhook-event.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Vatis Tech Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vatistech/y2ZncLKX2QwlXnvz/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/vatistech/y2ZncLKX2QwlXnvz/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vatistech/y2ZncLKX2QwlXnvz/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/vatistech/y2ZncLKX2QwlXnvz/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/vatistech/y2ZncLKX2QwlXnvz/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/vatistech/y2ZncLKX2QwlXnvz/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/vatistech/y2ZncLKX2QwlXnvz/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/vatistech/y2ZncLKX2QwlXnvz/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/vatistech/y2ZncLKX2QwlXnvz/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Webhook event - Vatis Tech Documentation\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Vatis Tech Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.vatis.tech/api-reference/schemas/webhook/webhook-event\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vatistech.mintlify.app/_mintlify/api/og/v2?division=Webhook\u0026amp;title=Webhook+event\u0026amp;theme=913cc6ff0c292f5e2762089d\u0026amp;signature=c698c4681dc6e95ddf0cc433d5aa944888e2174fc1aad450ba1b73ee7a345385\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Webhook event - Vatis Tech Documentation\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vatistech.mintlify.app/_mintlify/api/og/v2?division=Webhook\u0026amp;title=Webhook+event\u0026amp;theme=913cc6ff0c292f5e2762089d\u0026amp;signature=c698c4681dc6e95ddf0cc433d5aa944888e2174fc1aad450ba1b73ee7a345385\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/vatistech/y2ZncLKX2QwlXnvz/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Vatis Tech Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5EC269\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.vatis.tech/api-reference/schemas/webhook/webhook-event\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/schemas/webhook/webhook-event.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.vatis.tech/#organization\",\"name\":\"Vatis Tech Documentation\",\"url\":\"https://docs.vatis.tech\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/vatistech/o_HDtapknVDlgLdA/logo/logotype-green-black.svg?fit=max\u0026auto=format\u0026n=o_HDtapknVDlgLdA\u0026q=85\u0026s=32c1d7027a2cbf58f51a9dceb9ab19c0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.vatis.tech#website\",\"name\":\"Vatis Tech Documentation\",\"url\":\"https://docs.vatis.tech\",\"publisher\":{\"@id\":\"https://docs.vatis.tech/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.vatis.tech/api-reference/schemas/webhook/webhook-event#webpage\",\"url\":\"https://docs.vatis.tech/api-reference/schemas/webhook/webhook-event\",\"name\":\"Webhook event\",\"dateModified\":\"2025-09-15T09:59:50.552Z\",\"isPartOf\":{\"@id\":\"https://docs.vatis.tech#website\"},\"breadcrumb\":{\"@id\":\"https://docs.vatis.tech/api-reference/schemas/webhook/webhook-event#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.vatis.tech/api-reference/schemas/webhook/webhook-event#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Schemas\",\"item\":\"https://docs.vatis.tech/api-reference/schemas/egress/transcription-response\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Webhook event\",\"item\":\"https://docs.vatis.tech/api-reference/schemas/webhook/webhook-event\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.vatis.tech/api-reference/schemas/webhook/webhook-event#apireference\",\"headline\":\"Webhook event\",\"name\":\"Webhook event\",\"url\":\"https://docs.vatis.tech/api-reference/schemas/webhook/webhook-event\",\"mainEntityOfPage\":{\"@id\":\"https://docs.vatis.tech/api-reference/schemas/webhook/webhook-event#webpage\"},\"dateModified\":\"2025-09-15T09:59:50.552Z\",\"publisher\":{\"@id\":\"https://docs.vatis.tech/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.vatis.tech#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Vatis Tech Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Vatis Tech Documentation","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","groups":[{"group":"Vatis Docs","pages":[{"title":"Getting started","mode":"wide","href":"/introduction"},{"title":"Get API access","href":"/get-started/get-api-access"}]},{"group":"Speech to Text","pages":[{"title":"Multilingual Code Switch","href":"/speech-to-text/multilingual-code-switch"},{"title":"Utterance End","href":"/speech-to-text/utterance-end"},{"group":"Pre-recorded","pages":[{"title":"Getting Started","mode":"wide","href":"/speech-to-text/pre-recorded/getting-started"},{"title":"Features","href":"/speech-to-text/pre-recorded/features"},{"title":"Transcription languages","mode":"wide","href":"/speech-to-text/pre-recorded/transcription-languages"},{"title":"Pre-recorded Transcription","href":"/speech-to-text/pre-recorded/pre-recorded-transcription"},{"title":"Speaker Diarization","href":"/speech-to-text/pre-recorded/speaker-diarization"}]},{"group":"Real-time","pages":[{"title":"Getting Started","href":"/speech-to-text/real-time/getting-started"},{"title":"Features","href":"/speech-to-text/real-time/features"},{"title":"Transcription languages","mode":"wide","href":"/speech-to-text/real-time/transcription-languages"},{"title":"Real-time Transcription","href":"/speech-to-text/real-time/real-time-transcription"}]}]},{"group":"Audio Intelligence","pages":[{"title":"Summarization","href":"/audio-intelligence/summarization"},{"title":"Sentiment Analysis","href":"/audio-intelligence/sentiment-analysis"},{"title":"Ask Anything","href":"/audio-intelligence/ask-anything"}]},{"group":"Infrastructure","pages":[{"group":"Streams","pages":[{"title":"Inspect errors","href":"/infrastructure/streams/inspect-errors"}]},{"group":"Diagrams","pages":[{"title":"System overview","mode":"wide","href":"/infrastructure/diagrams/system-overview"},{"title":"Export results","href":"/infrastructure/diagrams/export-results"}]},{"title":"Data retention","href":"/infrastructure/data-retention"},{"title":"Stream templates","href":"/infrastructure/stream-templates"},{"title":"Configuration patches","href":"/infrastructure/configuration-patches"}]},{"group":"Integration","pages":[{"title":"Webhooks","href":"/integration/webhooks"},{"title":"Export","href":"/integration/export"},{"title":"Websocket","href":"/integration/websocket"}]}]},{"anchor":"API Reference","icon":"code","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","mode":"wide","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"}]},{"group":"Schemas","pages":[{"group":"Egress","pages":[{"title":null,"href":"/api-reference/schemas/egress/transcription-response"},{"title":null,"href":"/api-reference/schemas/egress/diarization-response"},{"title":null,"href":"/api-reference/schemas/egress/llm-response"},{"title":null,"href":"/api-reference/schemas/egress/stream-sink-message"}]},{"group":"Export","pages":[{"title":null,"href":"/api-reference/schemas/export/audio-intelligence-response"}]},{"group":"Websocket","pages":[{"title":null,"href":"/api-reference/schemas/websocket/stream-metadata"},{"title":null,"href":"/api-reference/schemas/websocket/configuration"},{"title":null,"href":"/api-reference/schemas/websocket/keep-alive"},{"title":null,"href":"/api-reference/schemas/websocket/response"},{"title":"End of Stream","href":"/api-reference/schemas/websocket/end-of-stream"},{"title":null,"description":null,"href":"/api-reference/schemas/websocket/error"}]},{"group":"Webhook","pages":[{"title":null,"href":"/api-reference/schemas/webhook/webhook-event"},{"group":"Event payload","pages":[{"title":null,"description":null,"href":"/api-reference/schemas/webhook/event-payload/stream-state-event"},{"title":null,"href":"/api-reference/schemas/webhook/event-payload/group-state-changed-event"},{"title":null,"href":"/api-reference/schemas/webhook/event-payload/group-stream-joined-event"},{"title":null,"href":"/api-reference/schemas/webhook/event-payload/stream-gateway-state-event"},{"title":null,"href":"/api-reference/schemas/webhook/event-payload/stream-processor-state-event"}]}]},{"group":"HTTP Gateway","pages":[{"title":null,"href":"/api-reference/schemas/http-gateway/stream-configuration"}]},{"group":"Errors","pages":[{"title":null,"href":"/api-reference/schemas/error/error-response"},{"title":"Internal error names","href":"/api-reference/schemas/error/internal-error-name"}]}]},{"group":"Authentication","pages":[{"title":"Authenticate","openapi":"POST /realms/vatistech/protocol/openid-connect/token","href":"/api-reference/commons/authenticate"}]},{"group":"Gateway","pages":[{"openapi":"post /http-gateway/api/v1/upload","title":"Upload","href":"/api-reference/gateway/upload"}]},{"group":"Streams","pages":[{"openapi":"get /stream-service/api/v1/streams","title":"Find all","href":"/api-reference/streams/stream-resource-impl/find-all"},{"openapi":"get /stream-service/api/v1/streams/{streamId}","title":"Find by id","href":"/api-reference/streams/stream-resource-impl/find-by-id"},{"openapi":"put /stream-service/api/v1/streams/{streamId}/cancel","title":"Cancel","href":"/api-reference/streams/stream-resource-impl/cancel"},{"openapi":"get /stream-service/api/v1/streams/{streamId}/components","title":"Get components","href":"/api-reference/streams/stream-resource-impl/get-components"}]},{"group":"Webhooks","pages":[{"openapi":"get /notification-service/api/v1/webhook-endpoints","title":"Find all","href":"/api-reference/webhooks/webhook-endpoint-resource-impl/find-all"},{"openapi":"put /notification-service/api/v1/webhook-endpoints","title":"Create/update","href":"/api-reference/webhooks/webhook-endpoint-resource-impl/createupdate"},{"openapi":"patch /notification-service/api/v1/webhook-endpoints/{id}/enabled/{enabled}","title":"Toggle endpoint","href":"/api-reference/webhooks/webhook-endpoint-resource-impl/toggle-endpoint"},{"openapi":"get /notification-service/api/v1/webhook-endpoints/{id}","title":"Find by ID","href":"/api-reference/webhooks/webhook-endpoint-resource-impl/find-by-id"},{"openapi":"delete /notification-service/api/v1/webhook-endpoints/{id}","title":"Delete","href":"/api-reference/webhooks/webhook-endpoint-resource-impl/delete"},{"openapi":"get /notification-service/api/v1/webhook-endpoints/supported-events","title":"Get available event type","href":"/api-reference/webhooks/webhook-endpoint-resource-impl/get-available-event-type"}]},{"group":"Export","pages":[{"openapi":"get /export-service/api/v1/export/{exportFormat}","title":"Export","href":"/api-reference/export/exports-a-stream-of-data-in-various-formats"}]},{"group":"Usage","pages":[{"openapi":"get /usage-service/api/v1/usage/streams/{streamId}","title":"Stream usage","href":"/api-reference/usage/stream-usage-resource-impl/stream-usage"},{"openapi":"get /usage-service/api/v1/usage/report","title":"Usage report","href":"/api-reference/usage/usage-report-resource-impl/usage-report"}]},{"group":"Stream configuration","pages":[{"openapi":"get /stream-configuration-service/api/v1/stream-configuration-templates","title":"Find all","href":"/api-reference/stream-configuration/stream-configuration-template-resource-impl/find-all"},{"openapi":"patch /stream-configuration-service/api/v1/stream-configuration-templates/{streamConfigurationTemplateId}","title":"Patch by id","href":"/api-reference/stream-configuration/stream-configuration-template-resource-impl/patch-by-id"}]},{"group":"Processor","pages":[{"openapi":"get /stream-configuration-service/api/v1/processor-declarations","title":"Find all","href":"/api-reference/stream-configuration/processor-declaration-resource-impl/find-all"}]}]},{"anchor":"Blog","href":"https://vatis.tech/blog","icon":"newspaper"}]},"basePath":"","title":"Webhook event - Vatis Tech Documentation","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}