Creates a webhook subscription on a Workstation application. Whenever one of the subscribed events happens on a task of that application, Tela sends an HTTP request to url with the event payload as JSON body.
JSON body Tela sends to your endpoint for every event. inputContent and outputContent are present
when the task has them; errorMessage is present for task.failed. outputContent is the task result:
a string for plain-text outputs, or an object/array for structured outputs.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Tela","colors":{"primary":"#171717","light":"#EBECED","dark":"#171717"},"logo":{"light":"https://mintcdn.com/meistrari/pblu7JGV78zF0-_0/logo/tela-docs-logo-light.svg?fit=max\u0026auto=format\u0026n=pblu7JGV78zF0-_0\u0026q=85\u0026s=2203db70c6af3499a392576fba857701","dark":"https://mintcdn.com/meistrari/pblu7JGV78zF0-_0/logo/tela-docs-logo-dark.svg?fit=max\u0026auto=format\u0026n=pblu7JGV78zF0-_0\u0026q=85\u0026s=a654991459d67d985930d693c2c84d53"},"favicon":"https://mintcdn.com/meistrari/pblu7JGV78zF0-_0/favicon.svg?fit=max\u0026auto=format\u0026n=pblu7JGV78zF0-_0\u0026q=85\u0026s=d467e03abcb66668deda7bd0eb39b121","background":{"color":{"dark":"#020913"}},"navbar":{"primary":{"type":"button","label":"Open Dashboard","href":"https://tela.com/app/dashboard"}},"search":{"prompt":"Search in TelaDocs"},"fonts":{"family":"Inter"},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":"en/welcome"},{"language":"pt-BR","href":"pt/welcome"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"meistrari","hasAudioNarration":false,"actualSubdomain":"meistrari","customDomains":["docs.tela.com"],"gitSource":{"type":"github","owner":"meistrari","repo":"tela-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae399c78fc5c9e41494669d","collectionId":"dc3ad1bf-097f-46e6-8ca4-0afa1e3e89ee","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae399c78fc5c9e41494669d"},"entitlements":{},"buildId":"6ae399c78fc5c9e41494669d","clientVersion":"0.0.4071","searchFilterCounts":[{"language":"default","tag":"API Reference","count":67},{"language":"en","tag":"Documentation","count":54},{"language":"pt-BR","tag":"Documentação","count":54},{"language":"en","tag":"Build","count":26},{"language":"pt-BR","tag":"Construir","count":26},{"language":"en","tag":"Integrate","count":12},{"language":"pt-BR","tag":"Integrar","count":12},{"language":"default","tag":"Workstation Events","count":10},{"language":"en","tag":"Workflow","count":10},{"language":"pt-BR","tag":"Workflow","count":10},{"language":"default","tag":"Versions","count":9},{"language":"default","tag":"Tasks","count":9},{"language":"default","tag":"Test case tags","count":9},{"language":"default","tag":"Test cases","count":8},{"language":"en","tag":"Agent","count":8},{"language":"pt-BR","tag":"Agente","count":8},{"language":"en","tag":"Completion API","count":7},{"language":"pt-BR","tag":"Completion API","count":7},{"language":"default","tag":"Environments","count":6},{"language":"en","tag":"Canvas","count":6},{"language":"en","tag":"Operate","count":6},{"language":"pt-BR","tag":"Canvas","count":6},{"language":"pt-BR","tag":"Operar","count":6},{"language":"default","tag":"Version messages","count":5},{"language":"en","tag":"Workstation","count":5},{"language":"en","tag":"Get started","count":5},{"language":"pt-BR","tag":"Workstation","count":5},{"language":"pt-BR","tag":"Primeiros passos","count":5},{"language":"default","tag":"Completions","count":3},{"language":"default","tag":"Workflow runs","count":3}]},"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":"rbac-expansion","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":"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":"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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--tela-text-primary: #262626;--tela-text-secondary: #737373;--tela-text-contrast: #171717;--tela-border: #e8e8e8;--tela-bg-hover: #f5f5f5;--tela-bg-active: #e8e8e8;--tela-weight-medium: 460;--tela-weight-semibold: 540;--tela-weight-heading: 520}html.dark{--tela-text-primary: #e8e8e8;--tela-text-secondary: #a3a3a3;--tela-text-contrast: #ffffff;--tela-border: rgba(255, 255, 255, 0.08);--tela-bg-hover: rgba(255, 255, 255, 0.04);--tela-bg-active: rgba(255, 255, 255, 0.08)}body{-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}#navbar-transition{border-bottom:0.5px solid var(--tela-border)}#sidebar{border-right:0.5px solid var(--tela-border)}#sidebar .sidebar-group-header{font-size:12px;line-height:16px;font-weight:var(--tela-weight-semibold);letter-spacing:0.05em;text-transform:uppercase;color:var(--tela-text-secondary)}#sidebar li>a,#sidebar li>button{border-radius:10px;font-size:14px;line-height:18px;letter-spacing:-0.15px;font-weight:var(--tela-weight-medium);color:var(--tela-text-secondary)}#sidebar li>a:hover,#sidebar li>button:hover{background-color:var(--tela-bg-hover);color:var(--tela-text-primary)}#sidebar li[data-active-nav-item=\"true\"]>a{background-color:var(--tela-bg-active);color:var(--tela-text-primary);font-weight:var(--tela-weight-semibold);text-shadow:none}#sidebar li[data-active-nav-item=\"true\"]>a svg{background-color:var(--tela-text-primary)}[data-layout-item=\"toc-item-link\"]{font-size:12px;line-height:16px;color:var(--tela-text-secondary)}[data-layout-item=\"toc-item-link\"][data-active=\"true\"],[data-layout-item=\"toc-item-link\"]:hover{color:var(--tela-text-contrast)}#header .eyebrow{font-size:12px;line-height:16px;font-weight:var(--tela-weight-semibold);letter-spacing:0.05em;text-transform:uppercase;color:var(--tela-text-secondary)}#page-title{font-size:32px;line-height:36px;letter-spacing:-1px;font-weight:var(--tela-weight-heading);color:var(--tela-text-contrast)}#content-area .mdx-content{color:var(--tela-text-primary);font-size:16px;line-height:28px;letter-spacing:-0.18px}#content-area .mdx-content h2{font-size:24px;line-height:28px;letter-spacing:-0.8px;font-weight:var(--tela-weight-heading);color:var(--tela-text-contrast)}#content-area .mdx-content h3{font-size:20px;line-height:24px;letter-spacing:-0.5px;font-weight:var(--tela-weight-heading);color:var(--tela-text-contrast)}#content-area .mdx-content h4{font-size:16px;line-height:20px;letter-spacing:-0.2px;font-weight:var(--tela-weight-heading);color:var(--tela-text-contrast)}#content-area .mdx-content h5{font-size:14px;line-height:16px;letter-spacing:-0.15px;font-weight:var(--tela-weight-heading);color:var(--tela-text-contrast)}#content-area .mdx-content h6{font-size:12px;line-height:14px;letter-spacing:-0.1px;font-weight:var(--tela-weight-heading);color:var(--tela-text-contrast)}#content-area .mdx-content strong{font-weight:var(--tela-weight-semibold)}#content-area .mdx-content .card,#content-area .mdx-content .callout{border-radius:12px}#content-area .mdx-content .card{border:0.5px solid var(--tela-border)}#content-area .mdx-content .frame{width:fit-content;max-width:100%;margin-inline:auto}#content-area .mdx-content .frame img{width:auto;max-width:100%;max-height:560px}"}],"page":{"pagePath":"api-reference/webhook/post-prompt-application-id-webhooks","slug":"/api-reference/webhook/post-prompt-application-id-webhooks","pageMetadata":{"title":"Create webhook subscription","description":"Creates a webhook subscription on a Workstation application. Whenever one of the subscribed `events` happens on a task of that application, Tela sends an HTTP request to `url` with the event payload as JSON body.","openapi":"POST /prompt-application/{id}/webhooks","href":"/api-reference/webhook/post-prompt-application-id-webhooks"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Creates a webhook subscription on a Workstation application. Whenever one of the subscribed \", _jsx(_components.code, {\n children: \"events\"\n }), \" happens on a task of that application, Tela sends an HTTP request to \", _jsx(_components.code, {\n children: \"url\"\n }), \" with the event payload as JSON body.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"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":{"title":"Create webhook subscription","description":"Creates a webhook subscription on a Workstation application. Whenever one of the subscribed `events` happens on a task of that application, Tela sends an HTTP request to `url` with the event payload as JSON body.","openapi":"POST /prompt-application/{id}/webhooks","href":"/api-reference/webhook/post-prompt-application-id-webhooks"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/meistrari/7fb0cf41bd7567c7/scripts/code-samples/chat/completions/v2/example.js"],"openApiReferenceData":{"operation":{"operationId":"createWebhook","summary":"Create webhook subscription","description":"Creates a webhook subscription on a Workstation application. Whenever one of the subscribed `events` happens on a task of that application, Tela sends an HTTP request to `url` with the event payload as JSON body.","tags":["Webhook"],"security":["a831753e-2d3a-4014-987b-708c69d708cf"],"parameters":["810896d3-89a9-4585-9dee-34f81707db4f"],"requestBody":"4957213a-6cf0-498f-983e-c98473521b43","responses":{"201":"bd092176-525a-4d87-915a-d66996e3663c","400":"a4c4d6dc-31e3-484b-ac33-165e03ad9fbb","401":"4031e9da-b549-45c9-b164-0d909db475e4","403":"8747955f-d987-4c91-8631-6bb7915e5134","404":"0dd1548a-6666-4819-b069-61401099f323","422":"4725e14b-0a96-41de-a615-dad9330b7b7c","500":"ee46be9b-68c7-438f-a055-f18a8e4edb78"},"callbacks":{"taskEvent":"dd906c5f-9191-4472-8e41-946b06d4f2c1"},"method":"post","type":"path","servers":["f8c8ecf7-c25f-4e5a-8e20-c44514cb2cac"],"path":"/prompt-application/{id}/webhooks","baseUrlOptions":["https://api.tela.com"],"title":"Create webhook subscription","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"810896d3-89a9-4585-9dee-34f81707db4f":{"name":"id","in":"path","required":true,"description":"Workstation application ID","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Workstation application ID","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":256,"description":"Display name of the subscription.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"url":{"type":"string","maxLength":2048,"description":"Endpoint URL. Must not resolve to localhost or private network ranges; HTTPS is required in production.","isRequired":true,"uniqueKey":"url","typeLabel":"string"},"events":{"type":"array","minItems":0,"items":{"type":"string","enum":["task.completed","task.approved","task.approval-revoke","task.failed"],"description":"Events a webhook can subscribe to:\n- `task.completed` — a task run finished successfully and is ready for review.\n- `task.approved` — a task was reviewed and approved.\n- `task.approval-revoke` — an approved task was sent back to `validating`.\n- `task.failed` — a task run ended with a failure (`errorMessage` is set in the payload).\n","uniqueKey":"events.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Events to subscribe to.","isRequired":true,"uniqueKey":"events","typeLabel":"enum\u003cstring>[]"},"headers":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"headers.oneOf.0.additionalProperties","typeLabel":"string"},"description":"Headers sent with every delivery (authentication tokens, correlation ids, ...).","uniqueKey":"headers.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"headers.oneOf.1.additionalProperties","typeLabel":"string"},"description":"Headers sent with every delivery (authentication tokens, correlation ids, ...).","uniqueKey":"headers.oneOf.1","typeLabel":"null"}],"uniqueKey":"headers","typeLabel":"object | null"},"sensitiveHeaders":{"type":"array","items":{"type":"string","uniqueKey":"sensitiveHeaders.items.[INDEX]","typeLabel":"string"},"description":"Names of the `headers` you consider sensitive. Defaults to `[]`.","uniqueKey":"sensitiveHeaders","typeLabel":"string[]"},"method":{"oneOf":[{"type":"string","maxLength":10,"description":"HTTP method for deliveries. Defaults to `POST`.","uniqueKey":"method.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":10,"description":"HTTP method for deliveries. Defaults to `POST`.","uniqueKey":"method.oneOf.1","typeLabel":"null"}],"uniqueKey":"method","typeLabel":"string | null"},"isActive":{"type":"boolean","description":"Defaults to `true`.","uniqueKey":"isActive","typeLabel":"boolean"},"promptApplicationId":{"oneOf":[{"type":"string","format":"uuid","description":"Ignored; the application is taken from the path.","uniqueKey":"promptApplicationId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Ignored; the application is taken from the path.","uniqueKey":"promptApplicationId.oneOf.1","typeLabel":"null"}],"uniqueKey":"promptApplicationId","typeLabel":"string\u003cuuid> | null"}},"required":["name","url","events"],"example":{"name":"ERP sync","url":"https://erp.example.com/hooks/tela","events":["task.completed","task.approved"],"headers":{"authorization":"Bearer erp-webhook-token"},"sensitiveHeaders":["authorization"]},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"ERP sync","url":"https://erp.example.com/hooks/tela","events":["task.completed","task.approved"],"headers":{"authorization":"Bearer erp-webhook-token"},"sensitiveHeaders":["authorization"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"bd092176-525a-4d87-915a-d66996e3663c":{"description":"Webhook created","content":{"application/json":{"schema":{"type":"object","description":"A webhook subscription of a Workstation application.","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"promptApplicationId":{"oneOf":[{"type":"string","format":"uuid","description":"Application the webhook belongs to.","isRequired":true,"uniqueKey":"promptApplicationId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Application the webhook belongs to.","isRequired":true,"uniqueKey":"promptApplicationId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"promptApplicationId","typeLabel":"string\u003cuuid> | null"},"name":{"type":"string","maxLength":256,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"url":{"type":"string","maxLength":2048,"description":"Endpoint that receives the events.","isRequired":true,"uniqueKey":"url","typeLabel":"string"},"events":{"type":"array","items":{"type":"string","enum":["task.completed","task.approved","task.approval-revoke","task.failed"],"description":"Events a webhook can subscribe to:\n- `task.completed` — a task run finished successfully and is ready for review.\n- `task.approved` — a task was reviewed and approved.\n- `task.approval-revoke` — an approved task was sent back to `validating`.\n- `task.failed` — a task run ended with a failure (`errorMessage` is set in the payload).\n","uniqueKey":"events.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"events","typeLabel":"enum\u003cstring>[]"},"headers":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"headers.oneOf.0.additionalProperties","typeLabel":"string"},"description":"Headers sent verbatim with every delivery. Use them for authentication (for example `authorization` or `x-api-key`).","isRequired":true,"uniqueKey":"headers.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"headers.oneOf.1.additionalProperties","typeLabel":"string"},"description":"Headers sent verbatim with every delivery. Use them for authentication (for example `authorization` or `x-api-key`).","isRequired":true,"uniqueKey":"headers.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"headers","typeLabel":"object | null"},"sensitiveHeaders":{"type":"array","items":{"type":"string","uniqueKey":"sensitiveHeaders.items.[INDEX]","typeLabel":"string"},"description":"Names of headers considered sensitive. Stored as provided; the API does not currently mask them in responses.","isRequired":true,"uniqueKey":"sensitiveHeaders","typeLabel":"string[]"},"method":{"oneOf":[{"type":"string","maxLength":10,"description":"HTTP method used for deliveries. Defaults to `POST`.","isRequired":true,"uniqueKey":"method.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":10,"description":"HTTP method used for deliveries. Defaults to `POST`.","isRequired":true,"uniqueKey":"method.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"method","typeLabel":"string | null"},"isActive":{"type":"boolean","description":"Inactive webhooks receive no deliveries.","isRequired":true,"uniqueKey":"isActive","typeLabel":"boolean"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"deletedAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"deletedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"deletedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"deletedAt","typeLabel":"string\u003cdate-time> | null"}},"required":["id","promptApplicationId","name","url","events","headers","sensitiveHeaders","method","isActive","createdAt","updatedAt","deletedAt"],"example":{"id":"7d8e9f0a-1b2c-4d3e-8f4a-5b6c7d8e9f0a","promptApplicationId":"c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f","name":"ERP sync","url":"https://erp.example.com/hooks/tela","events":["task.completed","task.approved"],"headers":{"authorization":"Bearer erp-webhook-token","x-source":"tela"},"sensitiveHeaders":["authorization"],"method":"POST","isActive":true,"createdAt":"2025-06-10T08:00:00.000Z","updatedAt":"2025-06-10T08:00:00.000Z","deletedAt":null},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"7d8e9f0a-1b2c-4d3e-8f4a-5b6c7d8e9f0a","promptApplicationId":"c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f","name":"ERP sync","url":"https://erp.example.com/hooks/tela","events":["task.completed","task.approved"],"headers":{"authorization":"Bearer erp-webhook-token","x-source":"tela"},"sensitiveHeaders":["authorization"],"method":"POST","isActive":true,"createdAt":"2025-06-10T08:00:00.000Z","updatedAt":"2025-06-10T08:00:00.000Z","deletedAt":null}}},"exampleType":"generated"}},"exampleType":"generated"},"a4c4d6dc-31e3-484b-ac33-165e03ad9fbb":{"description":"Invalid request","content":{"application/json":{"schema":{}}},"exampleType":"generated"},"4031e9da-b549-45c9-b164-0d909db475e4":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{}}},"exampleType":"generated"},"8747955f-d987-4c91-8631-6bb7915e5134":{"description":"The key does not have the required role","content":{"application/json":{"schema":{}}},"exampleType":"generated"},"0dd1548a-6666-4819-b069-61401099f323":{"description":"Application not found","content":{"application/json":{"schema":{}}},"exampleType":"generated"},"4725e14b-0a96-41de-a615-dad9330b7b7c":{"description":"Request body or query failed schema validation (`code` is `VALIDATION`)","content":{"application/json":{"schema":{}}},"exampleType":"generated"},"ee46be9b-68c7-438f-a055-f18a8e4edb78":{"description":"The URL was rejected (private network, non-HTTPS in production, or malformed). Currently surfaced as a server error rather than `400`.","content":{"application/json":{"schema":{}}},"exampleType":"generated"}},"callbacks":[{"callbackName":"taskEvent","expression":"{$request.body#/url}","method":"post","resolved":{"operation":{"summary":"Event delivery","description":"Sent by Tela to the subscribed URL for each subscribed event. Uses the configured `method`\n(default `POST`), `Content-Type: application/json`, the configured `headers`, and any\n`x-tela-forward-*` headers from the originating request. Times out after 30 seconds.\nDeliveries answered with a 4xx status are not retried; other failures are retried by the\ndelivery worker.\n","requestBody":"b43a3e17-a4ea-4413-83ad-b5c465bfaa2f","responses":{"2XX":"b781107e-74b7-43f4-a17f-4f2d9a43b0f6"},"method":"post","type":"path"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"JSON body Tela sends to your endpoint for every event. `inputContent` and `outputContent` are present\nwhen the task has them; `errorMessage` is present for `task.failed`. `outputContent` is the task result:\na string for plain-text outputs, or an object/array for structured outputs.\n","properties":{"id":{"type":"string","format":"uuid","description":"Unique id of this notification. Use it for deduplication; resends get a new id.","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"event":{"type":"string","enum":["task.completed","task.approved","task.approval-revoke","task.failed"],"description":"Events a webhook can subscribe to:\n- `task.completed` — a task run finished successfully and is ready for review.\n- `task.approved` — a task was reviewed and approved.\n- `task.approval-revoke` — an approved task was sent back to `validating`.\n- `task.failed` — a task run ended with a failure (`errorMessage` is set in the payload).\n","isRequired":true,"uniqueKey":"event","typeLabel":"enum\u003cstring>"},"timestamp":{"type":"string","format":"date-time","description":"When the notification was sent.","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"task":{"type":"object","description":"Snapshot of the task at the time of the event.","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"task.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"task.name","typeLabel":"string"},"status":{"type":"string","description":"Task status. Known values are `created`, `running`, `validating`, `completed`, `failed` and `cancelled`.","isRequired":true,"uniqueKey":"task.status","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"task.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"task.updatedAt","typeLabel":"string\u003cdate-time>"},"reference":{"oneOf":[{"type":"integer","description":"Human-readable task reference number.","uniqueKey":"task.reference.oneOf.0","typeLabel":"integer"},{"type":"string","description":"Human-readable task reference number.","uniqueKey":"task.reference.oneOf.1","typeLabel":"string"},{"type":"null","uniqueKey":"task.reference.oneOf.2","typeLabel":"null"}],"uniqueKey":"task.reference","typeLabel":"integer | string | null"},"approvedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"task.approvedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"task.approvedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"task.approvedAt","typeLabel":"string\u003cdate-time> | null"},"approvedBy":{"oneOf":[{"type":"string","description":"Email of the reviewer who approved the task.","uniqueKey":"task.approvedBy.oneOf.0","typeLabel":"string"},{"type":"null","description":"Email of the reviewer who approved the task.","uniqueKey":"task.approvedBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"task.approvedBy","typeLabel":"string | null"},"approvalRevokedAt":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"task.approvalRevokedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"task.approvalRevokedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"task.approvalRevokedAt","typeLabel":"string\u003cdate-time> | null"},"approvalRevokedBy":{"oneOf":[{"type":"string","uniqueKey":"task.approvalRevokedBy.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"task.approvalRevokedBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"task.approvalRevokedBy","typeLabel":"string | null"}},"required":["id","name","status","createdAt","updatedAt"],"isRequired":true,"uniqueKey":"task","typeLabel":"object"},"inputContent":{"oneOf":[{"type":"object","description":"The input the task was executed with.","properties":{"variables":{"type":"object","additionalProperties":true,"uniqueKey":"inputContent.oneOf.0.variables","typeLabel":"object"},"messages":{"type":"array","items":{"type":"object","uniqueKey":"inputContent.oneOf.0.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"inputContent.oneOf.0.messages","typeLabel":"object[]"},"files":{"type":"array","items":{"type":"object","description":"A file that was part of the task input. All fields are optional.","properties":{"name":{"type":"string","description":"Name of the variable the file was provided through.","uniqueKey":"inputContent.oneOf.0.files.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","uniqueKey":"inputContent.oneOf.0.files.items.[INDEX].type","typeLabel":"string"},"usedAt":{"type":"string","enum":["variables","messages"],"uniqueKey":"inputContent.oneOf.0.files.items.[INDEX].usedAt","typeLabel":"enum\u003cstring>"},"url":{"type":"string","uniqueKey":"inputContent.oneOf.0.files.items.[INDEX].url","typeLabel":"string"},"mimeType":{"type":"string","uniqueKey":"inputContent.oneOf.0.files.items.[INDEX].mimeType","typeLabel":"string"},"jobId":{"type":"string","uniqueKey":"inputContent.oneOf.0.files.items.[INDEX].jobId","typeLabel":"string"},"filename":{"type":"string","uniqueKey":"inputContent.oneOf.0.files.items.[INDEX].filename","typeLabel":"string"},"pages":{"type":"number","uniqueKey":"inputContent.oneOf.0.files.items.[INDEX].pages","typeLabel":"number"},"filePagesAsImage":{"type":"array","items":{"type":"string","uniqueKey":"inputContent.oneOf.0.files.items.[INDEX].filePagesAsImage.items.[INDEX]","typeLabel":"string"},"uniqueKey":"inputContent.oneOf.0.files.items.[INDEX].filePagesAsImage","typeLabel":"string[]"},"parserData":{"type":"object","description":"Result of the document parser for this file (status, extracted text, page count, ...).","uniqueKey":"inputContent.oneOf.0.files.items.[INDEX].parserData","typeLabel":"object"}},"uniqueKey":"inputContent.oneOf.0.files.items.[INDEX]","typeLabel":"object"},"uniqueKey":"inputContent.oneOf.0.files","typeLabel":"object[]"}},"uniqueKey":"inputContent.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"inputContent.oneOf.1","typeLabel":"null"}],"uniqueKey":"inputContent","typeLabel":"object | null"},"outputContent":{"oneOf":[{"type":"string","description":"Task result. String, object or array depending on the canvas output format.","uniqueKey":"outputContent.oneOf.0","typeLabel":"string"},{"type":"object","description":"Task result. String, object or array depending on the canvas output format.","uniqueKey":"outputContent.oneOf.1","typeLabel":"object"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"outputContent.oneOf.2.items.[INDEX]","typeLabel":"any"},"description":"Task result. String, object or array depending on the canvas output format.","uniqueKey":"outputContent.oneOf.2","typeLabel":"any[]"},{"type":"null","uniqueKey":"outputContent.oneOf.3","typeLabel":"null"}],"uniqueKey":"outputContent","typeLabel":"string | object | any[] | null"},"errorMessage":{"type":"string","description":"Failure reason, present on `task.failed`.","uniqueKey":"errorMessage","typeLabel":"string"}},"required":["id","event","timestamp","task"],"example":{"id":"4f5a6b7c-8d9e-4f0a-b1c2-d3e4f5a6b7c8","event":"task.completed","timestamp":"2025-06-11T14:03:12.000Z","task":{"id":"b83b1558-de5b-4e45-b517-7bececbdd154","name":"Contract 42 review","status":"completed","reference":42,"createdAt":"2025-06-11T14:00:01.000Z","updatedAt":"2025-06-11T14:03:11.000Z","approvedAt":null,"approvedBy":null,"approvalRevokedAt":null,"approvalRevokedBy":null},"inputContent":{"variables":{"document":{"files":[{"file_name":"contract-42.pdf","file_url":"https://files.example.com/contract-42.pdf","mime_type":"application/pdf"}]}},"files":[{"name":"document","usedAt":"variables","filename":"contract-42.pdf","mimeType":"application/pdf","url":"vault://a1b2c3d4","pages":12}],"messages":[]},"outputContent":{"summary":"Twelve-month services agreement with a 30-day termination clause.","risk":"low"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"4f5a6b7c-8d9e-4f0a-b1c2-d3e4f5a6b7c8","event":"task.completed","timestamp":"2025-06-11T14:03:12.000Z","task":{"id":"b83b1558-de5b-4e45-b517-7bececbdd154","name":"Contract 42 review","status":"completed","reference":42,"createdAt":"2025-06-11T14:00:01.000Z","updatedAt":"2025-06-11T14:03:11.000Z","approvedAt":null,"approvedBy":null,"approvalRevokedAt":null,"approvalRevokedBy":null},"inputContent":{"variables":{"document":{"files":[{"file_name":"contract-42.pdf","file_url":"https://files.example.com/contract-42.pdf","mime_type":"application/pdf"}]}},"files":[{"name":"document","usedAt":"variables","filename":"contract-42.pdf","mimeType":"application/pdf","url":"vault://a1b2c3d4","pages":12}],"messages":[]},"outputContent":{"summary":"Twelve-month services agreement with a 30-day termination clause.","risk":"low"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"b781107e-74b7-43f4-a17f-4f2d9a43b0f6":{"description":"Acknowledge the event. Any 2xx status marks the delivery as `success`.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{}}}}],"security":{"a831753e-2d3a-4014-987b-708c69d708cf":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT or UUID","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"f8c8ecf7-c25f-4e5a-8e20-c44514cb2cac":{"url":"https://api.tela.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT or UUID","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.yml"},"subdomain":"meistrari","siteName":"Tela","title":"Create webhook subscription - Tela","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/webhook/post-prompt-application-id-webhooks","matchLevel":0},"pt-BR":{"href":"/api-reference/webhook/post-prompt-application-id-webhooks","matchLevel":0}}},"lastModified":"2026-10-16T18:49:20.584Z","originalFileLocation":"api-reference/webhook/post-prompt-application-id-webhooks.mdx","locale":"en"},"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=\"description\" content=\"Creates a webhook subscription on a Workstation application. Whenever one of the subscribed events happens on a task of that application, Tela sends an HTTP request to url with the event payload as JSON body.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Tela\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/meistrari/iDbVYACJhr5G8i3-/_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/meistrari/iDbVYACJhr5G8i3-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/meistrari/iDbVYACJhr5G8i3-/_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/meistrari/iDbVYACJhr5G8i3-/_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/meistrari/iDbVYACJhr5G8i3-/_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/meistrari/iDbVYACJhr5G8i3-/_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/meistrari/iDbVYACJhr5G8i3-/_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/meistrari/iDbVYACJhr5G8i3-/_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/meistrari/iDbVYACJhr5G8i3-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create webhook subscription - Tela\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a webhook subscription on a Workstation application. Whenever one of the subscribed events happens on a task of that application, Tela sends an HTTP request to url with the event payload as JSON body.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Tela\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.tela.com/api-reference/webhook/post-prompt-application-id-webhooks\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://meistrari.mintlify.app/_mintlify/api/og/v2?division=Workstation+Events\u0026amp;title=Create+webhook+subscription\u0026amp;description=Creates+a+webhook+subscription+on+a+Workstation+application.+Whenever+one+of+the+subscribed+%60events%60+happens+on+a+task+of+that+application%2C+Tela+sends+an+HTTP+r\u0026amp;theme=bc02c453c572dc454ca5d848\u0026amp;signature=d5bd14b0e777459d6e5a41cfd3a521470f343461731fb33cc1a675556f14e30d\">\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=\"Create webhook subscription - Tela\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a webhook subscription on a Workstation application. Whenever one of the subscribed events happens on a task of that application, Tela sends an HTTP request to url with the event payload as JSON body.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://meistrari.mintlify.app/_mintlify/api/og/v2?division=Workstation+Events\u0026amp;title=Create+webhook+subscription\u0026amp;description=Creates+a+webhook+subscription+on+a+Workstation+application.+Whenever+one+of+the+subscribed+%60events%60+happens+on+a+task+of+that+application%2C+Tela+sends+an+HTTP+r\u0026amp;theme=bc02c453c572dc454ca5d848\u0026amp;signature=d5bd14b0e777459d6e5a41cfd3a521470f343461731fb33cc1a675556f14e30d\">\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/meistrari/iDbVYACJhr5G8i3-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Tela\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#171717\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.tela.com/api-reference/webhook/post-prompt-application-id-webhooks\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/webhook/post-prompt-application-id-webhooks.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.tela.com/#organization\",\"name\":\"Tela\",\"url\":\"https://docs.tela.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/meistrari/pblu7JGV78zF0-_0/logo/tela-docs-logo-light.svg?fit=max\u0026auto=format\u0026n=pblu7JGV78zF0-_0\u0026q=85\u0026s=2203db70c6af3499a392576fba857701\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.tela.com#website\",\"name\":\"Tela\",\"url\":\"https://docs.tela.com\",\"publisher\":{\"@id\":\"https://docs.tela.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.tela.com/api-reference/webhook/post-prompt-application-id-webhooks#webpage\",\"url\":\"https://docs.tela.com/api-reference/webhook/post-prompt-application-id-webhooks\",\"name\":\"Create webhook subscription\",\"description\":\"Creates a webhook subscription on a Workstation application. Whenever one of the subscribed events happens on a task of that application, Tela sends an HTTP request to url with the event payload as JSON body.\",\"dateModified\":\"2026-10-16T18:49:20.584Z\",\"isPartOf\":{\"@id\":\"https://docs.tela.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tela.com/api-reference/webhook/post-prompt-application-id-webhooks#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tela.com/api-reference/webhook/post-prompt-application-id-webhooks#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Tela\",\"item\":\"https://docs.tela.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create webhook subscription\",\"item\":\"https://docs.tela.com/api-reference/webhook/post-prompt-application-id-webhooks\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.tela.com/api-reference/webhook/post-prompt-application-id-webhooks#apireference\",\"headline\":\"Create webhook subscription\",\"name\":\"Create webhook subscription\",\"description\":\"Creates a webhook subscription on a Workstation application. Whenever one of the subscribed events happens on a task of that application, Tela sends an HTTP request to url with the event payload as JSON body.\",\"url\":\"https://docs.tela.com/api-reference/webhook/post-prompt-application-id-webhooks\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tela.com/api-reference/webhook/post-prompt-application-id-webhooks#webpage\"},\"dateModified\":\"2026-10-16T18:49:20.584Z\",\"publisher\":{\"@id\":\"https://docs.tela.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.tela.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Tela\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Tela","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/en/welcome"}]},{"tab":"API Reference","groups":[{"group":"Introduction","pages":[{"title":"Introduction","icon":"book-open","href":"/api-reference/introduction"}]},{"group":"Completions","pages":[{"title":"Run Canvas","openapi":"POST /v2/chat/completions","href":"/api-reference/completion/create"},{"title":"Retrieve Canvas Run","openapi":"GET /v2/chat/completions/{id}","href":"/api-reference/completion/get"},{"title":"List completion runs","openapi":"GET /v1/completion-run","href":"/api-reference/completion-run/get-v1-completion-run"}]},{"group":"Files","pages":[{"title":"Upload a File","openapi":"POST /v2/file","href":"/api-reference/file/create"},{"title":"Upload a File (v3)","openapi":"POST /v3/files","href":"/api-reference/file/upload"}]},{"group":"Canvases","pages":[{"title":"List canvases","openapi":"GET /prompt","href":"/api-reference/canvas/get-prompt"},{"title":"Get a canvas","openapi":"GET /prompt/{id}","href":"/api-reference/canvas/get-prompt-id"}]},{"group":"Versions","pages":[{"title":"List Prompt Versions","openapi":"GET /prompt-version","href":"/api-reference/prompt-version/get"},{"title":"Create Prompt Version","openapi":"POST /prompt-version","href":"/api-reference/prompt-version/create"},{"title":"Get Prompt Version","openapi":"GET /prompt-version/{id}","href":"/api-reference/prompt-version/get-by-id"},{"title":"Update Prompt Version","openapi":"PATCH /prompt-version/{id}","href":"/api-reference/prompt-version/update"},{"title":"Delete Prompt Version","openapi":"DELETE /prompt-version/{id}","href":"/api-reference/prompt-version/delete"},{"title":"Get the latest version of a canvas","openapi":"GET /prompt/{id}/latest-version","href":"/api-reference/prompt-version/get-prompt-id-latest-version"},{"title":"Get the promoted (production) version of a canvas","openapi":"GET /prompt/{id}/promoted-version","href":"/api-reference/prompt-version/get-prompt-id-promoted-version"},{"title":"List version history of a canvas","openapi":"GET /prompt-version/history","href":"/api-reference/prompt-version/get-prompt-version-history"},{"title":"Get the version index map of a canvas","openapi":"GET /prompt-version/index-map","href":"/api-reference/prompt-version/get-prompt-version-index-map"}]},{"group":"Version messages","pages":[{"title":"List messages of a prompt version","openapi":"GET /prompt-version-message","href":"/api-reference/prompt-version-message/get-prompt-version-message"},{"title":"Create a prompt version message","openapi":"POST /prompt-version-message","href":"/api-reference/prompt-version-message/post-prompt-version-message"},{"title":"Get a prompt version message","openapi":"GET /prompt-version-message/{id}","href":"/api-reference/prompt-version-message/get-prompt-version-message-id"},{"title":"Update a prompt version message","openapi":"PATCH /prompt-version-message/{id}","href":"/api-reference/prompt-version-message/patch-prompt-version-message-id"},{"title":"Delete a prompt version message","openapi":"DELETE /prompt-version-message/{id}","href":"/api-reference/prompt-version-message/delete-prompt-version-message-id"}]},{"group":"Environments","pages":[{"title":"List environments","openapi":"GET /environment","href":"/api-reference/environment/get-environment"},{"title":"Create environment","openapi":"POST /environment","href":"/api-reference/environment/post-environment"},{"title":"List environment publication history","openapi":"GET /environment/versions","href":"/api-reference/environment/get-environment-versions"},{"title":"Get the version published to an environment","openapi":"GET /environment/version","href":"/api-reference/environment/get-environment-version"},{"title":"Publish a version to an environment","openapi":"POST /environment/publish-by-name","href":"/api-reference/environment/post-environment-publish-by-name"},{"title":"Delete environment","openapi":"DELETE /environment/{id}","href":"/api-reference/environment/delete-environment-id"}]},{"group":"Test cases","pages":[{"title":"Retrieve Test Cases","openapi":"GET /test-case","href":"/api-reference/test-case/get"},{"title":"Create Test Cases","openapi":"POST /test-case","href":"/api-reference/test-case/create"},{"title":"Get Test Case by ID","openapi":"GET /test-case/{id}","href":"/api-reference/test-case/get-by-id"},{"title":"Update Test Case","openapi":"PATCH /test-case/{id}","href":"/api-reference/test-case/update"},{"title":"Delete Test Case","openapi":"DELETE /test-case/{id}","href":"/api-reference/test-case/delete"},{"title":"Run a test case","openapi":"POST /test-case/{id}/run","href":"/api-reference/test-case/post-test-case-id-run"},{"title":"Run many test cases","openapi":"POST /test-case/run-all","href":"/api-reference/test-case/post-test-case-run-all"},{"title":"Abort a running test case","openapi":"POST /test-case/{id}/abort","href":"/api-reference/test-case/post-test-case-id-abort"}]},{"group":"Test case tags","pages":[{"title":"Add tags to many test cases","openapi":"POST /test-case/bulk-add-tags","href":"/api-reference/test-case-tag/post-test-case-bulk-add-tags"},{"title":"Remove tags from many test cases","openapi":"POST /test-case/bulk-remove-tags","href":"/api-reference/test-case-tag/post-test-case-bulk-remove-tags"},{"title":"List tags of a test case","openapi":"GET /test-case/{id}/tags","href":"/api-reference/test-case-tag/get-test-case-id-tags"},{"title":"Assign tags to a test case","openapi":"POST /test-case/{id}/tags","href":"/api-reference/test-case-tag/post-test-case-id-tags"},{"title":"Remove a tag from a test case","openapi":"DELETE /test-case/{id}/tags/{tagId}","href":"/api-reference/test-case-tag/delete-test-case-id-tags-tagid"},{"title":"List test case tags of a canvas","openapi":"GET /test-case-tags","href":"/api-reference/test-case-tag/get-test-case-tags"},{"title":"Create a test case tag","openapi":"POST /test-case-tags","href":"/api-reference/test-case-tag/post-test-case-tags"},{"title":"Update a test case tag","openapi":"PATCH /test-case-tags/{id}","href":"/api-reference/test-case-tag/patch-test-case-tags-id"},{"title":"Delete a test case tag","openapi":"DELETE /test-case-tags/{id}","href":"/api-reference/test-case-tag/delete-test-case-tags-id"}]},{"group":"Tasks","pages":[{"title":"Query Tasks","openapi":"POST /task/query","href":"/api-reference/task/query"},{"title":"List tasks","openapi":"GET /task","href":"/api-reference/task/get-task"},{"title":"Create tasks","openapi":"POST /task","href":"/api-reference/task/post-task"},{"title":"Get a task","openapi":"GET /task/{id}","href":"/api-reference/task/get-task-id"},{"title":"Update a task","openapi":"PATCH /task/{id}","href":"/api-reference/task/patch-task-id"},{"title":"Delete a task","openapi":"DELETE /task/{id}","href":"/api-reference/task/delete-task-id"},{"title":"Create a task export job","openapi":"POST /task/export-job","href":"/api-reference/task/post-task-export-job"},{"title":"Get an export job","openapi":"GET /task/export-job/{id}","href":"/api-reference/task/get-task-export-job-id"},{"title":"Get an export download URL","description":"Returns a signed download URL for a completed export job. The URL is valid for `expiresIn` seconds (3600) and serves the file as `tela-tasks-export-{jobId}.{csv|json|zip}` (`zip` when the CSV export was generated in `separate` mode).","openapi":"GET /task/export-job/{id}/download","href":"/api-reference/task/get-task-export-job-id-download"}]},{"group":"Workstation Events","pages":[{"title":"Create webhook subscription","openapi":"POST /prompt-application/{id}/webhooks","href":"/api-reference/webhook/post-prompt-application-id-webhooks"},{"title":"List webhook subscriptions","description":"Returns the webhook subscriptions of an application, newest first, with pagination metadata.","openapi":"GET /prompt-application/{id}/webhooks","href":"/api-reference/webhook/get-prompt-application-id-webhooks"},{"title":"List webhook deliveries of an application","openapi":"GET /prompt-application/{id}/webhook-deliveries","href":"/api-reference/webhook/get-prompt-application-id-webhook-deliveries"},{"title":"Get webhook subscription","openapi":"GET /webhook/{webhookId}","href":"/api-reference/webhook/get-webhook-webhookid"},{"title":"Update webhook subscription","openapi":"PATCH /webhook/{webhookId}","href":"/api-reference/webhook/patch-webhook-webhookid"},{"title":"Delete webhook subscription","openapi":"DELETE /webhook/{webhookId}","href":"/api-reference/webhook/delete-webhook-webhookid"},{"title":"Send a test event to a webhook","openapi":"POST /webhook/{webhookId}/test","href":"/api-reference/webhook/post-webhook-webhookid-test"},{"title":"Send a test event to an arbitrary URL","openapi":"POST /webhook/test-url","href":"/api-reference/webhook/post-webhook-test-url"},{"title":"List deliveries of a webhook","openapi":"GET /webhook/{webhookId}/deliveries","href":"/api-reference/webhook/get-webhook-webhookid-deliveries"},{"title":"Resend a webhook delivery","openapi":"POST /webhook-delivery/{deliveryId}/resend","href":"/api-reference/webhook/post-webhook-delivery-deliveryid-resend"}]},{"group":"Workflow runs","pages":[{"title":"List workflow runs","openapi":"GET /workflow/runs","href":"/api-reference/workflow-run/get-workflow-runs"},{"title":"Get a workflow run","openapi":"GET /workflow/runs/{id}","href":"/api-reference/workflow-run/get-workflow-runs-id"},{"title":"Cancel a workflow run","openapi":"POST /workflow/runs/{id}/cancel","href":"/api-reference/workflow-run/post-workflow-runs-id-cancel"}]}]}]},{"language":"pt-BR","tabs":[{"tab":"Documentação","pages":[{"title":"Documentação","href":"/pt/welcome"}]},{"tab":"Referência de API","groups":[{"group":"Introdução","pages":[{"title":"Introduction","icon":"book-open","href":"/api-reference/introduction"}]},{"group":"Completions","pages":[{"title":"Run Canvas","openapi":"POST /v2/chat/completions","href":"/api-reference/completion/create"},{"title":"Retrieve Canvas Run","openapi":"GET /v2/chat/completions/{id}","href":"/api-reference/completion/get"},{"title":"List completion runs","openapi":"GET /v1/completion-run","href":"/api-reference/completion-run/get-v1-completion-run"}]},{"group":"Arquivos","pages":[{"title":"Upload a File","openapi":"POST /v2/file","href":"/api-reference/file/create"},{"title":"Upload a File (v3)","openapi":"POST /v3/files","href":"/api-reference/file/upload"}]},{"group":"Canvases","pages":[{"title":"List canvases","openapi":"GET /prompt","href":"/api-reference/canvas/get-prompt"},{"title":"Get a canvas","openapi":"GET /prompt/{id}","href":"/api-reference/canvas/get-prompt-id"}]},{"group":"Versões","pages":[{"title":"List Prompt Versions","openapi":"GET /prompt-version","href":"/api-reference/prompt-version/get"},{"title":"Create Prompt Version","openapi":"POST /prompt-version","href":"/api-reference/prompt-version/create"},{"title":"Get Prompt Version","openapi":"GET /prompt-version/{id}","href":"/api-reference/prompt-version/get-by-id"},{"title":"Update Prompt Version","openapi":"PATCH /prompt-version/{id}","href":"/api-reference/prompt-version/update"},{"title":"Delete Prompt Version","openapi":"DELETE /prompt-version/{id}","href":"/api-reference/prompt-version/delete"},{"title":"Get the latest version of a canvas","openapi":"GET /prompt/{id}/latest-version","href":"/api-reference/prompt-version/get-prompt-id-latest-version"},{"title":"Get the promoted (production) version of a canvas","openapi":"GET /prompt/{id}/promoted-version","href":"/api-reference/prompt-version/get-prompt-id-promoted-version"},{"title":"List version history of a canvas","openapi":"GET /prompt-version/history","href":"/api-reference/prompt-version/get-prompt-version-history"},{"title":"Get the version index map of a canvas","openapi":"GET /prompt-version/index-map","href":"/api-reference/prompt-version/get-prompt-version-index-map"}]},{"group":"Mensagens de versão","pages":[{"title":"List messages of a prompt version","openapi":"GET /prompt-version-message","href":"/api-reference/prompt-version-message/get-prompt-version-message"},{"title":"Create a prompt version message","openapi":"POST /prompt-version-message","href":"/api-reference/prompt-version-message/post-prompt-version-message"},{"title":"Get a prompt version message","openapi":"GET /prompt-version-message/{id}","href":"/api-reference/prompt-version-message/get-prompt-version-message-id"},{"title":"Update a prompt version message","openapi":"PATCH /prompt-version-message/{id}","href":"/api-reference/prompt-version-message/patch-prompt-version-message-id"},{"title":"Delete a prompt version message","openapi":"DELETE /prompt-version-message/{id}","href":"/api-reference/prompt-version-message/delete-prompt-version-message-id"}]},{"group":"Ambientes","pages":[{"title":"List environments","openapi":"GET /environment","href":"/api-reference/environment/get-environment"},{"title":"Create environment","openapi":"POST /environment","href":"/api-reference/environment/post-environment"},{"title":"List environment publication history","openapi":"GET /environment/versions","href":"/api-reference/environment/get-environment-versions"},{"title":"Get the version published to an environment","openapi":"GET /environment/version","href":"/api-reference/environment/get-environment-version"},{"title":"Publish a version to an environment","openapi":"POST /environment/publish-by-name","href":"/api-reference/environment/post-environment-publish-by-name"},{"title":"Delete environment","openapi":"DELETE /environment/{id}","href":"/api-reference/environment/delete-environment-id"}]},{"group":"Casos de teste","pages":[{"title":"Retrieve Test Cases","openapi":"GET /test-case","href":"/api-reference/test-case/get"},{"title":"Create Test Cases","openapi":"POST /test-case","href":"/api-reference/test-case/create"},{"title":"Get Test Case by ID","openapi":"GET /test-case/{id}","href":"/api-reference/test-case/get-by-id"},{"title":"Update Test Case","openapi":"PATCH /test-case/{id}","href":"/api-reference/test-case/update"},{"title":"Delete Test Case","openapi":"DELETE /test-case/{id}","href":"/api-reference/test-case/delete"},{"title":"Run a test case","openapi":"POST /test-case/{id}/run","href":"/api-reference/test-case/post-test-case-id-run"},{"title":"Run many test cases","openapi":"POST /test-case/run-all","href":"/api-reference/test-case/post-test-case-run-all"},{"title":"Abort a running test case","openapi":"POST /test-case/{id}/abort","href":"/api-reference/test-case/post-test-case-id-abort"}]},{"group":"Tags de casos de teste","pages":[{"title":"Add tags to many test cases","openapi":"POST /test-case/bulk-add-tags","href":"/api-reference/test-case-tag/post-test-case-bulk-add-tags"},{"title":"Remove tags from many test cases","openapi":"POST /test-case/bulk-remove-tags","href":"/api-reference/test-case-tag/post-test-case-bulk-remove-tags"},{"title":"List tags of a test case","openapi":"GET /test-case/{id}/tags","href":"/api-reference/test-case-tag/get-test-case-id-tags"},{"title":"Assign tags to a test case","openapi":"POST /test-case/{id}/tags","href":"/api-reference/test-case-tag/post-test-case-id-tags"},{"title":"Remove a tag from a test case","openapi":"DELETE /test-case/{id}/tags/{tagId}","href":"/api-reference/test-case-tag/delete-test-case-id-tags-tagid"},{"title":"List test case tags of a canvas","openapi":"GET /test-case-tags","href":"/api-reference/test-case-tag/get-test-case-tags"},{"title":"Create a test case tag","openapi":"POST /test-case-tags","href":"/api-reference/test-case-tag/post-test-case-tags"},{"title":"Update a test case tag","openapi":"PATCH /test-case-tags/{id}","href":"/api-reference/test-case-tag/patch-test-case-tags-id"},{"title":"Delete a test case tag","openapi":"DELETE /test-case-tags/{id}","href":"/api-reference/test-case-tag/delete-test-case-tags-id"}]},{"group":"Tarefas","pages":[{"title":"Query Tasks","openapi":"POST /task/query","href":"/api-reference/task/query"},{"title":"List tasks","openapi":"GET /task","href":"/api-reference/task/get-task"},{"title":"Create tasks","openapi":"POST /task","href":"/api-reference/task/post-task"},{"title":"Get a task","openapi":"GET /task/{id}","href":"/api-reference/task/get-task-id"},{"title":"Update a task","openapi":"PATCH /task/{id}","href":"/api-reference/task/patch-task-id"},{"title":"Delete a task","openapi":"DELETE /task/{id}","href":"/api-reference/task/delete-task-id"},{"title":"Create a task export job","openapi":"POST /task/export-job","href":"/api-reference/task/post-task-export-job"},{"title":"Get an export job","openapi":"GET /task/export-job/{id}","href":"/api-reference/task/get-task-export-job-id"},{"title":"Get an export download URL","description":"Returns a signed download URL for a completed export job. The URL is valid for `expiresIn` seconds (3600) and serves the file as `tela-tasks-export-{jobId}.{csv|json|zip}` (`zip` when the CSV export was generated in `separate` mode).","openapi":"GET /task/export-job/{id}/download","href":"/api-reference/task/get-task-export-job-id-download"}]},{"group":"Eventos da Workstation","pages":[{"title":"Create webhook subscription","openapi":"POST /prompt-application/{id}/webhooks","href":"/api-reference/webhook/post-prompt-application-id-webhooks"},{"title":"List webhook subscriptions","description":"Returns the webhook subscriptions of an application, newest first, with pagination metadata.","openapi":"GET /prompt-application/{id}/webhooks","href":"/api-reference/webhook/get-prompt-application-id-webhooks"},{"title":"List webhook deliveries of an application","openapi":"GET /prompt-application/{id}/webhook-deliveries","href":"/api-reference/webhook/get-prompt-application-id-webhook-deliveries"},{"title":"Get webhook subscription","openapi":"GET /webhook/{webhookId}","href":"/api-reference/webhook/get-webhook-webhookid"},{"title":"Update webhook subscription","openapi":"PATCH /webhook/{webhookId}","href":"/api-reference/webhook/patch-webhook-webhookid"},{"title":"Delete webhook subscription","openapi":"DELETE /webhook/{webhookId}","href":"/api-reference/webhook/delete-webhook-webhookid"},{"title":"Send a test event to a webhook","openapi":"POST /webhook/{webhookId}/test","href":"/api-reference/webhook/post-webhook-webhookid-test"},{"title":"Send a test event to an arbitrary URL","openapi":"POST /webhook/test-url","href":"/api-reference/webhook/post-webhook-test-url"},{"title":"List deliveries of a webhook","openapi":"GET /webhook/{webhookId}/deliveries","href":"/api-reference/webhook/get-webhook-webhookid-deliveries"},{"title":"Resend a webhook delivery","openapi":"POST /webhook-delivery/{deliveryId}/resend","href":"/api-reference/webhook/post-webhook-delivery-deliveryid-resend"}]},{"group":"Execuções de workflow","pages":[{"title":"List workflow runs","openapi":"GET /workflow/runs","href":"/api-reference/workflow-run/get-workflow-runs"},{"title":"Get a workflow run","openapi":"GET /workflow/runs/{id}","href":"/api-reference/workflow-run/get-workflow-runs-id"},{"title":"Cancel a workflow run","openapi":"POST /workflow/runs/{id}/cancel","href":"/api-reference/workflow-run/post-workflow-runs-id-cancel"}]}]}]}]},"basePath":"","title":"Create webhook subscription - Tela","buildId":"dpl_GZsjphRpnhWkstV12jxWNcMHFyox","deploymentId":"dpl_GZsjphRpnhWkstV12jxWNcMHFyox","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B5zPa4Vr.js","utils-CVjrr8Yd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DTgURWzl.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DxTHtkdZ.js","snippetPresets-Cx47o5Vx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-4Fr6y9N_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Dq2ElbEk.js","shallow-BfYl9r69.js","getApiPlaygroundDisplay-Ch3xc7i1.js","CodeSnippet-BsBxuJ1v.js","CodeSnippets-CetzeDL8.js","Page-CYZot51e.js","getPastedJson-BxPKFSJx.js","icon-o0J1Ochb.js","MethodPill-Du3usO5m.js","DuplicateIcon-DJypyMzl.js","createIcon-YMA6N8KJ.js","DynamicMarkdown-CWvhfcZc.js","SectionHeading-BdLVaXCd.js","axios-vUo_bRtp.js","Markdown-C4Ez6OeV.js","clsx-DptzKFCt.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Dt1IougW.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CZ6Wt2Vb.js"]}