{
"errors": [
{
"kind": "other",
"message": "No webhook with label 'prod-workflows' found"
}
]
}
Webhooks
Update a webhook
Update a registered webhook. label identifies which webhook to update and cannot be changed.
The editable fields are url and auth_header (pass auth_header: null to
remove a previously set header). event_types is not updatable — to change which events a
webhook subscribes to, delete it and create a new one. To change the signing secret, use the
rotate-secret endpoint. A successful update returns 200 with an empty body.
Optional. Set or replace the custom delivery auth header, or pass null to remove an
existing one.
Show child attributes
Response
Webhook updated successfully (empty body)
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Halliday","colors":{"primary":"#DDA2FF","light":"#DDA2FF","dark":"#DDA2FF"},"logo":{"light":"https://mintcdn.com/halliday/hq55KYeh-6LQtBNf/public/img/HallidayLogo_Color.png?fit=max\u0026auto=format\u0026n=hq55KYeh-6LQtBNf\u0026q=85\u0026s=486868ed309a361db91db1034289ee57","dark":"https://mintcdn.com/halliday/hq55KYeh-6LQtBNf/public/img/HallidayLogo_White.png?fit=max\u0026auto=format\u0026n=hq55KYeh-6LQtBNf\u0026q=85\u0026s=9ad14e1dc685e47fa07a382b14667a14"},"favicon":"https://mintcdn.com/halliday/hq55KYeh-6LQtBNf/public/favicon.ico?fit=max\u0026auto=format\u0026n=hq55KYeh-6LQtBNf\u0026q=85\u0026s=90797886eb509d21e8d5403d4e9ffc0a","navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Book a Sales Call","href":"https://calendly.com/dante-halliday/30min"}},"footer":{"socials":{"x":"https://x.com/HallidayHQ","linkedin":"https://www.linkedin.com/company/halliday"}},"contextual":{"options":["chatgpt","claude","copy","view"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://blog.halliday.xyz/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"halliday","hasAudioNarration":false,"actualSubdomain":"halliday","customDomains":["docs.halliday.xyz"],"gitSource":{"type":"github","owner":"hallidayinc","repo":"hallidaydocs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ada78fcbe8cb2c2b49b4c5b","collectionId":"6e9a0df0-e728-4cab-826e-5bb2eee2585b","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ada78fcbe8cb2c2b49b4c5b"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ada78fcbe8cb2c2b49b4c5b","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"default","tag":"Guides","count":24},{"language":"default","tag":"API Reference","count":22},{"language":"default","tag":"Payments","count":10},{"language":"default","tag":"Concepts \u0026 Info","count":6},{"language":"default","tag":"SDK Integrations","count":6},{"language":"default","tag":"Webhooks","count":6},{"language":"default","tag":"API Integrations","count":5},{"language":"default","tag":"Example Apps","count":4},{"language":"default","tag":"Assets","count":3},{"language":"default","tag":"Frequently Asked Questions","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"#topbar-cta-button>a>div>span{margin:0}#topbar-cta-button>a>div>svg{display:none}"}],"page":{"pagePath":"api-reference/webhooks/update-a-webhook","slug":"/api-reference/webhooks/update-a-webhook","pageMetadata":{"title":"Update a webhook","description":"Update a registered webhook. `label` identifies which webhook to update and cannot be changed.\nThe editable fields are **`url`** and **`auth_header`** (pass `auth_header: null` to\nremove a previously set header). `event_types` is not updatable — to change which events a\nwebhook subscribes to, delete it and create a new one. To change the signing secret, use the\nrotate-secret endpoint. A successful update returns `200` with an empty body.\n","deprecated":null,"version":null,"openapi":"/public/openapi.yaml patch /orgs/webhooks","href":"/api-reference/webhooks/update-a-webhook","autogeneratedByOpenApi":true},"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 strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Update a registered webhook. \", _jsx(_components.code, {\n children: \"label\"\n }), \" identifies which webhook to update and cannot be changed.\\nThe editable fields are \", _jsx(_components.strong, {\n children: _jsx(_components.code, {\n children: \"url\"\n })\n }), \" and \", _jsx(_components.strong, {\n children: _jsx(_components.code, {\n children: \"auth_header\"\n })\n }), \" (pass \", _jsx(_components.code, {\n children: \"auth_header: null\"\n }), \" to\\nremove a previously set header). \", _jsx(_components.code, {\n children: \"event_types\"\n }), \" is not updatable — to change which events a\\nwebhook subscribes to, delete it and create a new one. To change the signing secret, use the\\nrotate-secret endpoint. A successful update returns \", _jsx(_components.code, {\n children: \"200\"\n }), \" with an empty 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":"Update a webhook","description":"Update a registered webhook. `label` identifies which webhook to update and cannot be changed.\nThe editable fields are **`url`** and **`auth_header`** (pass `auth_header: null` to\nremove a previously set header). `event_types` is not updatable — to change which events a\nwebhook subscribes to, delete it and create a new one. To change the signing secret, use the\nrotate-secret endpoint. A successful update returns `200` with an empty body.\n","deprecated":null,"version":null,"openapi":"/public/openapi.yaml patch /orgs/webhooks","href":"/api-reference/webhooks/update-a-webhook","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Update a webhook","description":"Update a registered webhook. `label` identifies which webhook to update and cannot be changed.\nThe editable fields are **`url`** and **`auth_header`** (pass `auth_header: null` to\nremove a previously set header). `event_types` is not updatable — to change which events a\nwebhook subscribes to, delete it and create a new one. To change the signing secret, use the\nrotate-secret endpoint. A successful update returns `200` with an empty body.\n","operationId":"updateWebhook","tags":["Webhooks"],"requestBody":"ef74824c-52c2-43d7-8e72-b137c38e387d","responses":{"200":"730c7096-fcf9-4ce8-a9bb-a3e88b4d5941","400":"beb45bb3-30fb-4380-acca-bc98fc6fdf7d","401":"d2d296f8-0855-47d9-bc73-3fbc24adbb1b","404":"b280a507-6459-4313-88ea-1c9e9ba757ee"},"method":"patch","type":"path","servers":["b724eecd-a4ed-42fa-9a0c-8ff6407a392e"],"security":["05a97edf-e9d6-4de7-bdbe-ae97d91998f6"],"path":"/orgs/webhooks","baseUrlOptions":["https://v2.prod.halliday.xyz"],"title":"Update a webhook","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["label"],"properties":{"label":{"type":"string","description":"Identifies the webhook to update. Cannot be changed.","example":"prod-workflows","isRequired":true,"uniqueKey":"label","typeLabel":"string"},"url":{"type":"string","format":"uri","description":"Optional. New receiver URL. Must be HTTPS on port 443.","example":"https://api.yourapp.com/halliday/webhooks/v2","uniqueKey":"url","typeLabel":"string\u003curi>"},"auth_header":{"oneOf":[{"type":"object","description":"Optional. Set or replace the custom delivery auth header, or pass `null` to remove an\nexisting one.\n","required":["name","value"],"properties":{"name":{"type":"string","description":"Header name Halliday sends on each delivery.","example":"X-Webhook-Token","isRequired":true,"uniqueKey":"auth_header.oneOf.0.name","typeLabel":"string"},"value":{"type":"string","description":"Header value. Write-only — never returned.","example":"a-shared-secret-token","isRequired":true,"uniqueKey":"auth_header.oneOf.0.value","typeLabel":"string"}},"uniqueKey":"auth_header.oneOf.0","typeLabel":"object"},{"type":"null","description":"Optional. Set or replace the custom delivery auth header, or pass `null` to remove an\nexisting one.\n","uniqueKey":"auth_header.oneOf.1","typeLabel":"null"}],"uniqueKey":"auth_header","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"label":"prod-workflows","url":"https://api.yourapp.com/halliday/webhooks/v2"},"examples":{"Example":{"title":"Example","value":{"label":"prod-workflows","url":"https://api.yourapp.com/halliday/webhooks/v2"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"730c7096-fcf9-4ce8-a9bb-a3e88b4d5941":{"description":"Webhook updated successfully (empty body)","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"beb45bb3-30fb-4380-acca-bc98fc6fdf7d":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","description":"Returned when a request body fails schema validation. `errors` contains one entry per\nvalidation issue.\n","required":["errors"],"properties":{"errors":{"type":"array","items":{"type":"object","required":["code","path","message"],"properties":{"code":{"type":"string","description":"Validation issue code (for example `invalid_type`).","example":"invalid_type","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"path":{"type":"array","description":"Path to the offending field in the request body.","items":{"oneOf":[{"type":"string","uniqueKey":"errors.items.[INDEX].path.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"errors.items.[INDEX].path.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"errors.items.[INDEX].path.items.[INDEX]","typeLabel":"string | integer"},"example":["label"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].path","typeLabel":"(string | integer)[]"},"message":{"type":"string","example":"Invalid input: expected string, received undefined","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"expected":{"type":"string","description":"Expected type. Present on type-mismatch issues.","example":"string","uniqueKey":"errors.items.[INDEX].expected","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"code":"invalid_type","expected":"string","path":["label"],"message":"Invalid input: expected string, received undefined"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"invalid_type","expected":"string","path":["label"],"message":"Invalid input: expected string, received undefined"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"d2d296f8-0855-47d9-bc73-3fbc24adbb1b":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"oneOf":[{"type":"object","required":["kind","asset","given","limits","source","message","reason"],"properties":{"kind":{"type":"string","enum":["amount"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.kind","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Identifier in the token format (\"chain:address\") or fiat currency code (\"USD\")","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.asset","typeLabel":"string"},"given":{"type":"string","description":"A decimal amount string.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.given","typeLabel":"string"},"limits":{"type":"object","properties":{"min":{"type":"string","description":"Minimum amount as a decimal string.","uniqueKey":"errors.items.[INDEX].oneOf.0.limits.min","typeLabel":"string"},"max":{"type":"string","description":"Maximum amount as a decimal string.","uniqueKey":"errors.items.[INDEX].oneOf.0.limits.max","typeLabel":"string"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.limits","typeLabel":"object"},"source":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.source","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.message","typeLabel":"string"},"reason":{"type":"string","enum":["TOO_LOW","TOO_HIGH","UNEXPECTEDLY_LOW","UNEXPECTEDLY_HIGH","NO_VALID_AMOUNT","UNKNOWN"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.reason","typeLabel":"enum\u003cstring>"},"downstream_limits":{"type":"object","properties":{"min":{"type":"string","description":"Minimum amount as a decimal string.","uniqueKey":"errors.items.[INDEX].oneOf.0.downstream_limits.min","typeLabel":"string"},"max":{"type":"string","description":"Maximum amount as a decimal string.","uniqueKey":"errors.items.[INDEX].oneOf.0.downstream_limits.max","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.0.downstream_limits","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["kind","token","balance"],"properties":{"kind":{"type":"string","enum":["funding"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.kind","typeLabel":"enum\u003cstring>"},"token":{"type":"string","description":"Token identifier in the format \"chain:address\"","pattern":"^[a-z]+:0x[a-fA-F0-9]+$","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.token","typeLabel":"string"},"balance":{"type":"object","required":["#"],"properties":{"#":{"type":"string","description":"Balance amount as a decimal string.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.balance.#","typeLabel":"string"}},"description":"Current token balance at the funding address.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.balance","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["kind","message","mitigation"],"properties":{"kind":{"type":"string","enum":["owner"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.2.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.2.message","typeLabel":"string"},"mitigation":{"type":"string","enum":["change","verify"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.2.mitigation","typeLabel":"enum\u003cstring>"}},"uniqueKey":"errors.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["geolocation"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.3.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.3.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["provider"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.4.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.4.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["payin_method"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.5.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.5.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.5","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["other"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.6.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.6.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.6","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["unknown"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.7.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.7.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.7","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["org_configuration"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.8.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.8.message","typeLabel":"string"},"rev_share_pct":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.8.rev_share_pct","typeLabel":"string"},"total_pct":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.8.total_pct","typeLabel":"string"},"threshold":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.8.threshold","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.8","typeLabel":"object"},{"type":"object","description":"Funds are held at a deposit address associated with the owner and are not being processed.","required":["kind","token","balance","classification","severity","payment_gist","withdraw_from"],"properties":{"kind":{"type":"string","enum":["parked_fund"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.kind","typeLabel":"enum\u003cstring>"},"token":{"type":"string","description":"Token identifier in the format \"chain:address\"","pattern":"^[a-z]+:0x[a-fA-F0-9]+$","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.token","typeLabel":"string"},"balance":{"type":"object","required":["#"],"properties":{"#":{"type":"string","description":"Integer amount in the token's smallest unit, serialized as a string.","example":"25500000","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.balance.#","typeLabel":"string"}},"description":"Token balance parked at the address, as an integer in the token's smallest unit. The `{\"#\": \"...\"}`\nwrapper is how the API serializes integers too large for a JSON number. Divide by the token's\n`decimals` from `GET /assets` to display it, for example `{\"#\": \"25500000\"}` is 25.5 USDC.\nNote that `POST /payments/balances` reports the same funds as a plain decimal string (`\"25.5\"`).\n","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.balance","typeLabel":"object"},"classification":{"type":"string","enum":["MISSENT","STUCK","UNDERFUNDED","STALLED","EXTRA","SLIPPED","DELAYED"],"description":"Why the funds are parked.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.classification","typeLabel":"enum\u003cstring>"},"severity":{"type":"string","enum":["HIGH","LOW"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.severity","typeLabel":"enum\u003cstring>"},"payment_gist":{"oneOf":[{"type":"object","description":"Summary of the payment the funds were intended for, or null.","required":["op","destination_address","destination_token"],"properties":{"op":{"type":"string","enum":["buy"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.0.op","typeLabel":"enum\u003cstring>"},"destination_address":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.0.destination_address","typeLabel":"string"},"destination_token":{"type":"string","description":"Token identifier in the format \"chain:address\"","pattern":"^[a-z]+:0x[a-fA-F0-9]+$","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.0.destination_token","typeLabel":"string"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.0","typeLabel":"object"},{"type":"null","description":"Summary of the payment the funds were intended for, or null.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist","typeLabel":"object | null"},"withdraw_from":{"oneOf":[{"type":"object","description":"Where the parked funds can be withdrawn from, or null if they cannot be withdrawn through the API.","required":["withdraw_type","payment_id","withdraw_account"],"properties":{"withdraw_type":{"type":"string","enum":["PAYMENT"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.0.withdraw_type","typeLabel":"enum\u003cstring>"},"payment_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.0.payment_id","typeLabel":"string\u003cuuid>"},"withdraw_account":{"type":"string","enum":["INTENT","SPW","RDW"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.0.withdraw_account","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.0","typeLabel":"object"},{"type":"object","description":"Where the parked funds can be withdrawn from, or null if they cannot be withdrawn through the API.","required":["withdraw_type","rdw_address"],"properties":{"withdraw_type":{"type":"string","enum":["EXTRA_RDW_BALANCE"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.1.withdraw_type","typeLabel":"enum\u003cstring>"},"rdw_address":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.1.rdw_address","typeLabel":"string"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.1","typeLabel":"object"},{"type":"null","description":"Where the parked funds can be withdrawn from, or null if they cannot be withdrawn through the API.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from","typeLabel":"object · object · null"}},"uniqueKey":"errors.items.[INDEX].oneOf.9","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["destination"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.10.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.10.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.10","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["payout_method"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.11.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.11.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.11","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["kyc"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.12.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.12.message","typeLabel":"string"},"provider_id":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.12.provider_id","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.12","typeLabel":"object"}],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"description":"Error response for known errors","uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"kind":"other","message":"Invalid API key"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"kind":"other","message":"Invalid API key"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"b280a507-6459-4313-88ea-1c9e9ba757ee":{"description":"Webhook not found","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","items":{"oneOf":[{"type":"object","required":["kind","asset","given","limits","source","message","reason"],"properties":{"kind":{"type":"string","enum":["amount"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.kind","typeLabel":"enum\u003cstring>"},"asset":{"type":"string","description":"Identifier in the token format (\"chain:address\") or fiat currency code (\"USD\")","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.asset","typeLabel":"string"},"given":{"type":"string","description":"A decimal amount string.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.given","typeLabel":"string"},"limits":{"type":"object","properties":{"min":{"type":"string","description":"Minimum amount as a decimal string.","uniqueKey":"errors.items.[INDEX].oneOf.0.limits.min","typeLabel":"string"},"max":{"type":"string","description":"Maximum amount as a decimal string.","uniqueKey":"errors.items.[INDEX].oneOf.0.limits.max","typeLabel":"string"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.limits","typeLabel":"object"},"source":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.source","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.message","typeLabel":"string"},"reason":{"type":"string","enum":["TOO_LOW","TOO_HIGH","UNEXPECTEDLY_LOW","UNEXPECTEDLY_HIGH","NO_VALID_AMOUNT","UNKNOWN"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.reason","typeLabel":"enum\u003cstring>"},"downstream_limits":{"type":"object","properties":{"min":{"type":"string","description":"Minimum amount as a decimal string.","uniqueKey":"errors.items.[INDEX].oneOf.0.downstream_limits.min","typeLabel":"string"},"max":{"type":"string","description":"Maximum amount as a decimal string.","uniqueKey":"errors.items.[INDEX].oneOf.0.downstream_limits.max","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.0.downstream_limits","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["kind","token","balance"],"properties":{"kind":{"type":"string","enum":["funding"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.kind","typeLabel":"enum\u003cstring>"},"token":{"type":"string","description":"Token identifier in the format \"chain:address\"","pattern":"^[a-z]+:0x[a-fA-F0-9]+$","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.token","typeLabel":"string"},"balance":{"type":"object","required":["#"],"properties":{"#":{"type":"string","description":"Balance amount as a decimal string.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.balance.#","typeLabel":"string"}},"description":"Current token balance at the funding address.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.balance","typeLabel":"object"}},"uniqueKey":"errors.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["kind","message","mitigation"],"properties":{"kind":{"type":"string","enum":["owner"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.2.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.2.message","typeLabel":"string"},"mitigation":{"type":"string","enum":["change","verify"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.2.mitigation","typeLabel":"enum\u003cstring>"}},"uniqueKey":"errors.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["geolocation"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.3.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.3.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["provider"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.4.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.4.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["payin_method"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.5.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.5.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.5","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["other"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.6.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.6.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.6","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["unknown"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.7.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.7.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.7","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["org_configuration"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.8.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.8.message","typeLabel":"string"},"rev_share_pct":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.8.rev_share_pct","typeLabel":"string"},"total_pct":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.8.total_pct","typeLabel":"string"},"threshold":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.8.threshold","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.8","typeLabel":"object"},{"type":"object","description":"Funds are held at a deposit address associated with the owner and are not being processed.","required":["kind","token","balance","classification","severity","payment_gist","withdraw_from"],"properties":{"kind":{"type":"string","enum":["parked_fund"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.kind","typeLabel":"enum\u003cstring>"},"token":{"type":"string","description":"Token identifier in the format \"chain:address\"","pattern":"^[a-z]+:0x[a-fA-F0-9]+$","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.token","typeLabel":"string"},"balance":{"type":"object","required":["#"],"properties":{"#":{"type":"string","description":"Integer amount in the token's smallest unit, serialized as a string.","example":"25500000","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.balance.#","typeLabel":"string"}},"description":"Token balance parked at the address, as an integer in the token's smallest unit. The `{\"#\": \"...\"}`\nwrapper is how the API serializes integers too large for a JSON number. Divide by the token's\n`decimals` from `GET /assets` to display it, for example `{\"#\": \"25500000\"}` is 25.5 USDC.\nNote that `POST /payments/balances` reports the same funds as a plain decimal string (`\"25.5\"`).\n","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.balance","typeLabel":"object"},"classification":{"type":"string","enum":["MISSENT","STUCK","UNDERFUNDED","STALLED","EXTRA","SLIPPED","DELAYED"],"description":"Why the funds are parked.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.classification","typeLabel":"enum\u003cstring>"},"severity":{"type":"string","enum":["HIGH","LOW"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.severity","typeLabel":"enum\u003cstring>"},"payment_gist":{"oneOf":[{"type":"object","description":"Summary of the payment the funds were intended for, or null.","required":["op","destination_address","destination_token"],"properties":{"op":{"type":"string","enum":["buy"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.0.op","typeLabel":"enum\u003cstring>"},"destination_address":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.0.destination_address","typeLabel":"string"},"destination_token":{"type":"string","description":"Token identifier in the format \"chain:address\"","pattern":"^[a-z]+:0x[a-fA-F0-9]+$","example":"ethereum:0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.0.destination_token","typeLabel":"string"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.0","typeLabel":"object"},{"type":"null","description":"Summary of the payment the funds were intended for, or null.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.payment_gist","typeLabel":"object | null"},"withdraw_from":{"oneOf":[{"type":"object","description":"Where the parked funds can be withdrawn from, or null if they cannot be withdrawn through the API.","required":["withdraw_type","payment_id","withdraw_account"],"properties":{"withdraw_type":{"type":"string","enum":["PAYMENT"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.0.withdraw_type","typeLabel":"enum\u003cstring>"},"payment_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.0.payment_id","typeLabel":"string\u003cuuid>"},"withdraw_account":{"type":"string","enum":["INTENT","SPW","RDW"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.0.withdraw_account","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.0","typeLabel":"object"},{"type":"object","description":"Where the parked funds can be withdrawn from, or null if they cannot be withdrawn through the API.","required":["withdraw_type","rdw_address"],"properties":{"withdraw_type":{"type":"string","enum":["EXTRA_RDW_BALANCE"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.1.withdraw_type","typeLabel":"enum\u003cstring>"},"rdw_address":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.1.rdw_address","typeLabel":"string"}},"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.1","typeLabel":"object"},{"type":"null","description":"Where the parked funds can be withdrawn from, or null if they cannot be withdrawn through the API.","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.withdraw_from","typeLabel":"object · object · null"}},"uniqueKey":"errors.items.[INDEX].oneOf.9","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["destination"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.10.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.10.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.10","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["payout_method"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.11.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.11.message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.11","typeLabel":"object"},{"type":"object","required":["kind","message"],"properties":{"kind":{"type":"string","enum":["kyc"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.12.kind","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.12.message","typeLabel":"string"},"provider_id":{"type":"string","uniqueKey":"errors.items.[INDEX].oneOf.12.provider_id","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX].oneOf.12","typeLabel":"object"}],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"}},"description":"Error response for known errors","uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"kind":"other","message":"No webhook with label 'prod-workflows' found"}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"kind":"other","message":"No webhook with label 'prod-workflows' found"}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"05a97edf-e9d6-4de7-bdbe-ae97d91998f6":{"ApiKeyAuth":{"type":"http","scheme":"bearer","bearerFormat":"API_KEY","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"b724eecd-a4ed-42fa-9a0c-8ff6407a392e":{"url":"https://v2.prod.halliday.xyz","description":"Base domain"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API_KEY","scopes":[],"schemeName":"ApiKeyAuth"},"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":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"public/openapi.yaml"},"subdomain":"halliday","siteName":"Halliday","title":"Update a webhook - Halliday","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-22T20:58:42.712Z","originalFileLocation":"api-reference/webhooks/update-a-webhook.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=\"description\" content=\"Update a registered webhook. label identifies which webhook to update and cannot be changed. The editable fields are url and auth_header (pass auth_header: null to remove a previously set header). event_types is not updatable — to change which events a webhook subscribes to, delete it and create a new one. To change the signing secret, use the rotate-secret endpoint. A successful update returns 200 with an empty body.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Halliday\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/halliday/_TQmu18IvjSU-Uvs/_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/halliday/_TQmu18IvjSU-Uvs/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/halliday/_TQmu18IvjSU-Uvs/_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/halliday/_TQmu18IvjSU-Uvs/_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/halliday/_TQmu18IvjSU-Uvs/_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/halliday/_TQmu18IvjSU-Uvs/_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/halliday/_TQmu18IvjSU-Uvs/_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/halliday/_TQmu18IvjSU-Uvs/_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/halliday/_TQmu18IvjSU-Uvs/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a webhook - Halliday\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update a registered webhook. label identifies which webhook to update and cannot be changed. The editable fields are url and auth_header (pass auth_header: null to remove a previously set header). event_types is not updatable — to change which events a webhook subscribes to, delete it and create a new one. To change the signing secret, use the rotate-secret endpoint. A successful update returns 200 with an empty body.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Halliday\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.halliday.xyz/api-reference/webhooks/update-a-webhook\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://halliday.mintlify.app/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Update+a+webhook\u0026amp;description=Update+a+registered+webhook.+%60label%60+identifies+which+webhook+to+update+and+cannot+be+changed.%0AThe+editable+fields+are+**%60url%60**+and+**%60auth_header%60**+%28pass+%60au\u0026amp;theme=e9b080815c8cb7f41ee5a38d\u0026amp;signature=093da80580f07980e782f43c2b35fc705a2ca40122f527bd752bb1c9f222b22e\">\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=\"Update a webhook - Halliday\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update a registered webhook. label identifies which webhook to update and cannot be changed. The editable fields are url and auth_header (pass auth_header: null to remove a previously set header). event_types is not updatable — to change which events a webhook subscribes to, delete it and create a new one. To change the signing secret, use the rotate-secret endpoint. A successful update returns 200 with an empty body.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://halliday.mintlify.app/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Update+a+webhook\u0026amp;description=Update+a+registered+webhook.+%60label%60+identifies+which+webhook+to+update+and+cannot+be+changed.%0AThe+editable+fields+are+**%60url%60**+and+**%60auth_header%60**+%28pass+%60au\u0026amp;theme=e9b080815c8cb7f41ee5a38d\u0026amp;signature=093da80580f07980e782f43c2b35fc705a2ca40122f527bd752bb1c9f222b22e\">\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/halliday/_TQmu18IvjSU-Uvs/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Halliday\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#DDA2FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.halliday.xyz/api-reference/webhooks/update-a-webhook\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/webhooks/update-a-webhook.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.halliday.xyz/#organization\",\"name\":\"Halliday\",\"url\":\"https://docs.halliday.xyz\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/halliday/hq55KYeh-6LQtBNf/public/img/HallidayLogo_Color.png?fit=max\u0026auto=format\u0026n=hq55KYeh-6LQtBNf\u0026q=85\u0026s=486868ed309a361db91db1034289ee57\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.halliday.xyz#website\",\"name\":\"Halliday\",\"url\":\"https://docs.halliday.xyz\",\"publisher\":{\"@id\":\"https://docs.halliday.xyz/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.halliday.xyz/api-reference/webhooks/update-a-webhook#webpage\",\"url\":\"https://docs.halliday.xyz/api-reference/webhooks/update-a-webhook\",\"name\":\"Update a webhook\",\"description\":\"Update a registered webhook. label identifies which webhook to update and cannot be changed. The editable fields are url and auth_header (pass auth_header: null to remove a previously set header). event_types is not updatable — to change which events a webhook subscribes to, delete it and create a new one. To change the signing secret, use the rotate-secret endpoint. A successful update returns 200 with an empty body.\",\"dateModified\":\"2026-10-22T20:58:42.712Z\",\"isPartOf\":{\"@id\":\"https://docs.halliday.xyz#website\"},\"breadcrumb\":{\"@id\":\"https://docs.halliday.xyz/api-reference/webhooks/update-a-webhook#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.halliday.xyz/api-reference/webhooks/update-a-webhook#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Webhooks\",\"item\":\"https://docs.halliday.xyz/api-reference/webhooks/list-webhooks\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update a webhook\",\"item\":\"https://docs.halliday.xyz/api-reference/webhooks/update-a-webhook\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.halliday.xyz/api-reference/webhooks/update-a-webhook#apireference\",\"headline\":\"Update a webhook\",\"name\":\"Update a webhook\",\"description\":\"Update a registered webhook. label identifies which webhook to update and cannot be changed. The editable fields are url and auth_header (pass auth_header: null to remove a previously set header). event_types is not updatable — to change which events a webhook subscribes to, delete it and create a new one. To change the signing secret, use the rotate-secret endpoint. A successful update returns 200 with an empty body.\",\"url\":\"https://docs.halliday.xyz/api-reference/webhooks/update-a-webhook\",\"mainEntityOfPage\":{\"@id\":\"https://docs.halliday.xyz/api-reference/webhooks/update-a-webhook#webpage\"},\"dateModified\":\"2026-10-22T20:58:42.712Z\",\"publisher\":{\"@id\":\"https://docs.halliday.xyz/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.halliday.xyz#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Halliday\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Halliday","nav":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://blog.halliday.xyz/"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/pages/home"}]},{"tab":"API Reference","groups":[{"group":"Chains","pages":[{"title":"Get supported chains","deprecated":null,"version":null,"openapi":"/public/openapi.yaml get /chains","href":"/api-reference/chains/get-supported-chains"}]},{"group":"Assets","pages":[{"title":"Get asset details","deprecated":null,"version":null,"openapi":"/public/openapi.yaml get /assets","href":"/api-reference/assets/get-asset-details"},{"title":"Get available input assets for a given output asset","deprecated":null,"version":null,"openapi":"/public/openapi.yaml get /assets/available-inputs","href":"/api-reference/assets/get-available-input-assets-for-a-given-output-asset"},{"title":"Get available output assets for a given input asset","deprecated":null,"version":null,"openapi":"/public/openapi.yaml get /assets/available-outputs","href":"/api-reference/assets/get-available-output-assets-for-a-given-input-asset"}]},{"group":"Geolocation","pages":[{"title":"Get geolocation for an IP address","deprecated":null,"version":null,"openapi":"/public/openapi.yaml get /geolocation","href":"/api-reference/geolocation/get-geolocation-for-an-ip-address"}]},{"group":"Prices","pages":[{"title":"Get token prices","deprecated":null,"version":null,"openapi":"/public/openapi.yaml post /prices","href":"/api-reference/prices/get-token-prices"}]},{"group":"Payments","pages":[{"title":"Get payment status","deprecated":null,"version":null,"openapi":"/public/openapi.yaml get /payments","href":"/api-reference/payments/get-payment-status"},{"title":"Get payment history","deprecated":null,"version":null,"openapi":"/public/openapi.yaml get /payments/history","href":"/api-reference/payments/get-payment-history"},{"title":"Get available payment methods","deprecated":null,"version":null,"openapi":"/public/openapi.yaml get /payments/methods","href":"/api-reference/payments/get-available-payment-methods"},{"title":"Get payment quotes","deprecated":null,"version":null,"openapi":"/public/openapi.yaml post /payments/quotes","href":"/api-reference/payments/get-payment-quotes"},{"title":"Confirm a payment","deprecated":null,"version":null,"openapi":"/public/openapi.yaml post /payments/confirm","href":"/api-reference/payments/confirm-a-payment"},{"title":"Return funds to owner or retry payment","deprecated":null,"version":null,"openapi":"/public/openapi.yaml post /payments/withdraw","href":"/api-reference/payments/return-funds-to-owner-or-retry-payment"},{"title":"Confirm withdrawal request","deprecated":null,"version":null,"openapi":"/public/openapi.yaml post /payments/withdraw/confirm","href":"/api-reference/payments/confirm-withdrawal-request"},{"title":"Get withdrawal status","deprecated":null,"version":null,"openapi":"/public/openapi.yaml get /payments/withdraw/status","href":"/api-reference/payments/get-withdrawal-status"},{"title":"Get wallet balances","deprecated":null,"version":null,"openapi":"/public/openapi.yaml post /payments/balances","href":"/api-reference/payments/get-wallet-balances"},{"title":"Get issues for an owner address","deprecated":null,"version":null,"openapi":"/public/openapi.yaml post /payments/issues","href":"/api-reference/payments/get-issues-for-an-owner-address"}]},{"group":"Webhooks","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/public/openapi.yaml get /orgs/webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Register a webhook","deprecated":null,"version":null,"openapi":"/public/openapi.yaml post /orgs/webhooks","href":"/api-reference/webhooks/register-a-webhook"},{"title":"Delete a webhook","description":"Delete a registered webhook, identified by its `label`.\n","deprecated":null,"version":null,"openapi":"/public/openapi.yaml delete /orgs/webhooks","href":"/api-reference/webhooks/delete-a-webhook"},{"title":"Update a webhook","deprecated":null,"version":null,"openapi":"/public/openapi.yaml patch /orgs/webhooks","href":"/api-reference/webhooks/update-a-webhook"},{"title":"Rotate the signing secret","description":"Generate a new signing secret for a webhook. The new key is added immediately and signs\nalongside any existing keys, so deliveries carry multiple `v1=` signatures during the overlap\nand you can roll the secret in your verifier without downtime.\n\nThe previous keys are only phased out if you pass `retire_after` (floored to at least 24h from\nnow). **Omit `retire_after` and the previous secret stays active indefinitely** — both keep\nsigning. The response returns the webhook `id` and the new `signing_secret`; store it now, as\nit is not retrievable later.\n","deprecated":null,"version":null,"openapi":"/public/openapi.yaml post /orgs/webhooks/rotate-secret","href":"/api-reference/webhooks/rotate-the-signing-secret"},{"title":"Workflow status changed","version":null,"deprecated":null,"openapi":"/public/openapi.yaml webhook workflowStatusChanged","href":"/api-reference/webhooks/workflow-status-changed"}]}]}]},"title":"Update a webhook - Halliday","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","Page-R3M_BF4L.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}