{
"type": "https://docs.alura.io/errors/invalid_request",
"title": "Invalid request",
"status": 400,
"code": "invalid_request",
"detail": "Invalid request",
"suggestion": "Fix the request as the detail says, then send it again.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}
{
"type": "https://docs.alura.io/errors/unauthorized",
"title": "Unauthorized",
"status": 401,
"code": "unauthorized",
"detail": "Unauthorized",
"suggestion": "Send a valid API key as `Authorization: Bearer alura_sk_...`.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}
{
"type": "https://docs.alura.io/errors/credits_exhausted",
"title": "API credits exhausted",
"status": 402,
"code": "credits_exhausted",
"detail": "API credits exhausted",
"suggestion": "Upgrade the plan or wait for the monthly reset.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}
{
"type": "https://docs.alura.io/errors/plan_required",
"title": "Plan required",
"status": 403,
"code": "plan_required",
"detail": "Plan required",
"suggestion": "Upgrade the workspace plan to use this operation.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}
{
"type": "https://docs.alura.io/errors/not_found",
"title": "Not found",
"status": 404,
"code": "not_found",
"detail": "Not found",
"suggestion": "Check the ID, or search for it first.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}
{
"type": "https://docs.alura.io/errors/method_not_allowed",
"title": "Method not allowed",
"status": 405,
"code": "method_not_allowed",
"detail": "Method not allowed",
"suggestion": "Use one of the methods in the Allow header.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}
{
"type": "https://docs.alura.io/errors/conflict",
"title": "Conflict",
"status": 409,
"code": "conflict",
"detail": "Conflict",
"suggestion": "Reload the resource and retry with its current state.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}
{
"type": "https://docs.alura.io/errors/invalid_request",
"title": "Invalid request",
"status": 400,
"code": "invalid_request",
"detail": "Invalid request",
"suggestion": "Fix the request as the detail says, then send it again.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}
{
"type": "https://docs.alura.io/errors/unauthorized",
"title": "Unauthorized",
"status": 401,
"code": "unauthorized",
"detail": "Unauthorized",
"suggestion": "Send a valid API key as `Authorization: Bearer alura_sk_...`.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}
{
"type": "https://docs.alura.io/errors/credits_exhausted",
"title": "API credits exhausted",
"status": 402,
"code": "credits_exhausted",
"detail": "API credits exhausted",
"suggestion": "Upgrade the plan or wait for the monthly reset.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}
{
"type": "https://docs.alura.io/errors/plan_required",
"title": "Plan required",
"status": 403,
"code": "plan_required",
"detail": "Plan required",
"suggestion": "Upgrade the workspace plan to use this operation.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}
{
"type": "https://docs.alura.io/errors/not_found",
"title": "Not found",
"status": 404,
"code": "not_found",
"detail": "Not found",
"suggestion": "Check the ID, or search for it first.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}
{
"type": "https://docs.alura.io/errors/method_not_allowed",
"title": "Method not allowed",
"status": 405,
"code": "method_not_allowed",
"detail": "Method not allowed",
"suggestion": "Use one of the methods in the Allow header.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}
{
"type": "https://docs.alura.io/errors/conflict",
"title": "Conflict",
"status": 409,
"code": "conflict",
"detail": "Conflict",
"suggestion": "Reload the resource and retry with its current state.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}
Makes a retry safe: the same key with the same request within 24 hours returns the first result (with Idempotent-Replayed: true) instead of writing again. The same key with a different request is a 409 conflict; while the first request still runs, 409 idempotency_processing.
The signing secret (whsec_...). Shown once, in this answer; store it to verify deliveries.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Alura API","description":"Etsy market research for scripts and AI assistants: products, shops, keywords and saved research.","colors":{"primary":"#155EEF","light":"#528BFF","dark":"#004EEB"},"logo":{"light":"https://mintcdn.com/alura/HySS5CT36sWBL9EL/logo/light.svg?fit=max\u0026auto=format\u0026n=HySS5CT36sWBL9EL\u0026q=85\u0026s=6afcc5174d02ee0af4c233126964240a","dark":"https://mintcdn.com/alura/HySS5CT36sWBL9EL/logo/dark.svg?fit=max\u0026auto=format\u0026n=HySS5CT36sWBL9EL\u0026q=85\u0026s=0babd9724a17bbf017bb0d29d0943900","href":"https://alura.io"},"favicon":"https://mintcdn.com/alura/HySS5CT36sWBL9EL/favicon.svg?fit=max\u0026auto=format\u0026n=HySS5CT36sWBL9EL\u0026q=85\u0026s=4a49d66ca34eb4e2b084d778927ed570","api":{"playground":{"display":"none","proxy":false},"examples":{"languages":["curl","typescript","python"]}},"background":{"color":{"light":"#FFFFFF","dark":"#171717"}},"navbar":{"links":[{"href":"/status","label":"Status"}],"primary":{"type":"button","label":"Get an API key","href":"https://platform.alura.io/settings"}},"footer":{"socials":{"website":"https://alura.io"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"alura","hasAudioNarration":false,"actualSubdomain":"alura","customDomains":["docs.alura.io"],"gitSource":{"type":"github","owner":"pixell-co","repo":"alura-public-api","deployBranch":"main","contentDirectory":"apps/docs/content","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6aef4f3f4f6351e51850c94d","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"API reference","count":141},{"language":"default","tag":"Your shop","count":76},{"language":"default","tag":"Research","count":37},{"language":"default","tag":"Documentation","count":34},{"language":"default","tag":"Shop","count":34},{"language":"default","tag":"Listings","count":22},{"language":"default","tag":"Etsy","count":16},{"language":"default","tag":"Saved","count":14},{"language":"default","tag":"Shipping profiles","count":13},{"language":"default","tag":"Webhooks \u0026 events","count":12}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"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":"editor-metadata","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},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"a[href=\"https://platform.alura.io/settings\"]:not(.link){background-color:transparent!important}a[href=\"https://platform.alura.io/settings\"]:not(.link)>span:first-child,html.dark a[href=\"https://platform.alura.io/settings\"]:not(.link)>span:first-child{background-color:#155EEF!important}a[href=\"https://platform.alura.io/settings\"]:not(.link),a[href=\"https://platform.alura.io/settings\"]:not(.link) *{color:#FFFFFF!important}a[href=\"https://platform.alura.io/settings\"]:not(.link):hover>span:first-child{background-color:#004EEB!important}a[href=\"https://platform.alura.io/settings\"][target=\"_blank\"]:not(.link) svg{display:none!important}a[href=\"https://platform.alura.io/settings\"]:not(.link),a[href=\"https://platform.alura.io/settings\"]:not(.link)>span:first-child,button:not([role=\"switch\"]):not([role=\"tab\"]),.sidebar-group a,#search-bar-entry,#search-bar-entry-mobile{border-radius:9999px!important}#page-context-menu-button{border-radius:0.75rem 0 0 0.75rem!important}#page-context-menu-button+button{border-radius:0 0.75rem 0.75rem 0!important}#topbar-cta-button>a{padding:0.375rem 0.875rem!important;font-size:0.8125rem!important}[data-component-part=\"update-tag\"],[data-component-part=\"update-description\"]{font-size:0.75rem;line-height:1.25rem}[data-component-part=\"update-tag-list\"]{flex-direction:column;gap:0.25rem}[data-component-part=\"update-tag\"]{opacity:0.7}[data-component-part=\"update-content\"]>h2:first-child{margin-top:0;font-size:1.5rem;line-height:2rem}[data-component-part=\"update-content\"] h3{font-size:1rem;margin-top:1.75rem}"}],"page":{"pagePath":"api-reference/webhooks/endpoints/rotatesecret","slug":"/api-reference/webhooks/endpoints/rotatesecret","pageMetadata":{"title":"Rotate secret","description":"Replace a webhook endpoint's signing secret. The old secret keeps signing for 24 hours, so you can switch your verifier without missing a delivery.","deprecated":null,"version":null,"sidebarTitle":"Rotate secret","openapi":"/openapi.json post /v1/webhooks/{id}/rotate-secret","href":"/api-reference/webhooks/endpoints/rotatesecret","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Replace a webhook endpoint’s signing secret. The old secret keeps signing for 24 hours, so you can switch your verifier without missing a delivery.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{Accordion,AccordionGroup,CodeBlock,Heading}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!AccordionGroup)_missingMdxReference(`AccordionGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Cost:`}),` Free.`]}),`\n`,_jsx(CodeBlock,{numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.alura.io/v1/webhooks/we_01JMOCK0000000000000000000/rotate-secret\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$ALURA_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Idempotency-Key: 3f6c2a9e-1b4d-4c7a-9e2f-8d5b6a7c1e0f\"`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Needs the `,_jsx(_components.code,{children:`webhooks:write`}),` scope, and `,_jsx(_components.code,{children:`orders:read`}),` as well on an endpoint with order event types. The answer carries the new secret once.`]}),`\n`,_jsx(Heading,{level:`2`,id:`switch-without-missing-a-delivery`,children:`Switch without missing a delivery`}),`\n`,_jsxs(_components.p,{children:[`For 24 hours, every delivery carries a signature from each secret: two in `,_jsx(_components.code,{children:`webhook-signature`}),`, separated by a space.`]}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsx(_components.li,{children:`Rotate, and store the new secret.`}),`\n`,_jsx(_components.li,{children:`Deploy your verifier with the new secret. Deliveries verify with either secret meanwhile, so the order of your deploys doesn’t matter.`}),`\n`,_jsx(_components.li,{children:`After 24 hours, deliveries carry only the new signature.`}),`\n`]}),`\n`,_jsxs(AccordionGroup,{children:[_jsx(Accordion,{title:`Rotating again within 24 hours`,id:`rotating-again-within-24-hours`,children:_jsx(_components.p,{children:`The secret on its way out keeps its remaining time, and the one in between ends at once. A delivery never carries more than two signatures.`})}),_jsx(Accordion,{title:`Retrying a rotation`,id:`retrying-a-rotation`,children:_jsxs(_components.p,{children:[`Send an `,_jsx(_components.code,{children:`Idempotency-Key`}),`. A retry with the same key answers the same secret instead of making another. See `,_jsx(_components.a,{href:`/api-reference/introduction#idempotency`,children:`Idempotency`}),`.`]})})]}),`\n`,_jsxs(_components.p,{children:[`How signatures work is on `,_jsx(_components.a,{href:`/guides/verifying-webhooks`,children:`Verifying webhooks`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Rotate secret","description":"Replace a webhook endpoint's signing secret. The old secret keeps signing for 24 hours, so you can switch your verifier without missing a delivery.","deprecated":null,"version":null,"sidebarTitle":"Rotate secret","openapi":"/openapi.json post /v1/webhooks/{id}/rotate-secret","href":"/api-reference/webhooks/endpoints/rotatesecret","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Switch without missing a delivery","slug":"switch-without-missing-a-delivery","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"webhooks.endpoints.rotateSecret","summary":"Rotate secret","description":"Replace a webhook endpoint's signing secret. The old secret keeps signing for 24 hours, so you can switch your verifier without missing a delivery.","parameters":["780b58b6-50c9-46ae-aeb2-41439be8da33","01987a26-b138-4224-81e7-faf8fc46a1b8"],"responses":{"200":"46193c3b-7209-4ab4-adf2-09d1a3c9ab27","400":"3f463acb-3a48-4657-a3be-025e821323cc","401":"18c112d1-1393-4ae4-a6ee-a0f750da585d","402":"743ed0e7-caf9-4eef-9565-489f37e26aff","403":"309fb847-2f5f-4e69-9073-1488105460af","404":"9460062e-b257-43dc-bf3e-9ddb0aaf0188","405":"8bc61d83-cce2-4449-9a31-4b25dae632c7","409":"ac62971f-86f3-43e3-937d-e995707ae867","429":"d91c6b41-7535-4530-9b02-ec31306d0b2a","500":"63fa4004-2674-4b8e-a3e2-a4d70868d531","503":"3006dee7-2a7a-4911-817d-6821fc55ee02"},"x-alura-credits":{"credits":0,"unit":"call"},"x-alura-scopes":["webhooks:write"],"x-codeSamples":[{"lang":"bash","label":"cURL","source":"curl -X POST \"https://api.alura.io/v1/webhooks/we_01JMOCK0000000000000000000/rotate-secret\" \\\n -H \"Authorization: Bearer $ALURA_API_KEY\" \\\n -H \"Idempotency-Key: 5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c\""},{"lang":"typescript","label":"TypeScript","source":"const res = await fetch('https://api.alura.io/v1/webhooks/we_01JMOCK0000000000000000000/rotate-secret', {\n method: 'POST',\n headers: {\n Authorization: `Bearer ${process.env.ALURA_API_KEY}`,\n 'Idempotency-Key': '5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c',\n },\n});\nconsole.log(await res.json());"},{"lang":"python","label":"Python","source":"import json\nimport os\nimport urllib.request\n\nrequest = urllib.request.Request(\n \"https://api.alura.io/v1/webhooks/we_01JMOCK0000000000000000000/rotate-secret\",\n method=\"POST\",\n headers={\n \"Authorization\": f\"Bearer {os.environ['ALURA_API_KEY']}\",\n \"Idempotency-Key\": \"5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c\",\n },\n)\nwith urllib.request.urlopen(request) as response:\n print(json.load(response))"}],"x-mint":{"href":"/api-reference/webhooks/endpoints/rotateSecret","metadata":{"sidebarTitle":"Rotate secret","description":"Replace a webhook endpoint's signing secret. The old secret keeps signing for 24 hours, so you can switch your verifier without missing a delivery."},"content":"**Cost:** Free.\n\n```bash\ncurl -X POST \"https://api.alura.io/v1/webhooks/we_01JMOCK0000000000000000000/rotate-secret\" \\\n -H \"Authorization: Bearer $ALURA_API_KEY\" \\\n -H \"Idempotency-Key: 3f6c2a9e-1b4d-4c7a-9e2f-8d5b6a7c1e0f\"\n```\n\nNeeds the `webhooks:write` scope, and `orders:read` as well on an endpoint with order event types. The answer carries the new secret once.\n\n## Switch without missing a delivery\n\nFor 24 hours, every delivery carries a signature from each secret: two in `webhook-signature`, separated by a space.\n\n1. Rotate, and store the new secret.\n2. Deploy your verifier with the new secret. Deliveries verify with either secret meanwhile, so the order of your deploys doesn't matter.\n3. After 24 hours, deliveries carry only the new signature.\n\n\u003cAccordionGroup>\n\u003cAccordion title=\"Rotating again within 24 hours\">\nThe secret on its way out keeps its remaining time, and the one in between ends at once. A delivery never carries more than two signatures.\n\u003c/Accordion>\n\n\u003cAccordion title=\"Retrying a rotation\">\nSend an `Idempotency-Key`. A retry with the same key answers the same secret instead of making another. See [Idempotency](/api-reference/introduction#idempotency).\n\u003c/Accordion>\n\u003c/AccordionGroup>\n\nHow signatures work is on [Verifying webhooks](/guides/verifying-webhooks)."},"method":"post","type":"path","servers":["6c764af2-fbc8-469e-a5ff-745270cc266b"],"security":["6144536c-06b0-4b8d-affd-b8dccec7d5ee"],"path":"/v1/webhooks/{id}/rotate-secret","baseUrlOptions":["https://api.alura.io"],"title":"Rotate secret","codeSamples":[{"label":"cURL","lang":"bash","source":"curl -X POST \"https://api.alura.io/v1/webhooks/we_01JMOCK0000000000000000000/rotate-secret\" \\\n -H \"Authorization: Bearer $ALURA_API_KEY\" \\\n -H \"Idempotency-Key: 5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c\""},{"label":"TypeScript","lang":"typescript","source":"const res = await fetch('https://api.alura.io/v1/webhooks/we_01JMOCK0000000000000000000/rotate-secret', {\n method: 'POST',\n headers: {\n Authorization: `Bearer ${process.env.ALURA_API_KEY}`,\n 'Idempotency-Key': '5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c',\n },\n});\nconsole.log(await res.json());"},{"label":"Python","lang":"python","source":"import json\nimport os\nimport urllib.request\n\nrequest = urllib.request.Request(\n \"https://api.alura.io/v1/webhooks/we_01JMOCK0000000000000000000/rotate-secret\",\n method=\"POST\",\n headers={\n \"Authorization\": f\"Bearer {os.environ['ALURA_API_KEY']}\",\n \"Idempotency-Key\": \"5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c\",\n },\n)\nwith urllib.request.urlopen(request) as response:\n print(json.load(response))"}],"requestExampleLanguages":["bash","typescript","python"],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"780b58b6-50c9-46ae-aeb2-41439be8da33":{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":64,"description":"The webhook endpoint ID (`we_...`).","example":"we_01JMOCK0000000000000000000","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"01987a26-b138-4224-81e7-faf8fc46a1b8":{"name":"Idempotency-Key","in":"header","required":false,"description":"Makes a retry safe: the same key with the same request within 24 hours returns the first result (with `Idempotent-Replayed: true`) instead of writing again. The same key with a different request is a 409 `conflict`; while the first request still runs, 409 `idempotency_processing`.","schema":{"type":"string","minLength":1,"maxLength":255,"isRequired":false,"description":"Makes a retry safe: the same key with the same request within 24 hours returns the first result (with `Idempotent-Replayed: true`) instead of writing again. The same key with a different request is a 409 `conflict`; while the first request still runs, 409 `idempotency_processing`.","uniqueKey":"","typeLabel":"string"}}},"responses":{"46193c3b-7209-4ab4-adf2-09d1a3c9ab27":{"description":"OK","headers":{"Request-Id":{"description":"`req_` + ULID; quote it when reporting a problem.","schema":{"type":"string"}},"Alura-Credits-Cost":{"description":"API credits this call cost.","schema":{"type":"integer"}},"Alura-Credits-Remaining":{"description":"API credits left in the workspace's monthly allowance, counting calls still in flight. Absent when it cannot be read right now.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","const":"webhook_endpoint","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"id":{"type":"string","description":"`we_...`","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"url":{"type":"string","description":"Where events are sent: an HTTPS URL.","isRequired":true,"uniqueKey":"url","typeLabel":"string"},"description":{"oneOf":[{"description":"Your note for this endpoint; null when none was set.","type":"string","isRequired":true,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"description":"Your note for this endpoint; null when none was set.","type":"null","isRequired":true,"uniqueKey":"description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"description","typeLabel":"string | null"},"event_types":{"type":"array","items":{"type":"string","uniqueKey":"event_types.items.[INDEX]","typeLabel":"string"},"description":"Etsy's event types this endpoint receives: `*` for every type, an exact type such as `order.paid`, or a prefix such as `order.*`.","isRequired":true,"uniqueKey":"event_types","typeLabel":"string[]"},"shop_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"shop_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Only events of these connected shops; null for every connected shop of the workspace, including shops connected later.","isRequired":true,"uniqueKey":"shop_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Only events of these connected shops; null for every connected shop of the workspace, including shops connected later.","isRequired":true,"uniqueKey":"shop_ids.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"shop_ids","typeLabel":"string[] | null"},"status":{"type":"string","enum":["enabled","disabled"],"description":"`enabled` receives events; `disabled` receives none until enabled again.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"disabled_reason":{"oneOf":[{"type":"string","description":"Why a disabled endpoint is disabled: `manual` (PATCH) or `failing` (deliveries kept failing). Null while enabled.","enum":["manual","failing"],"isRequired":true,"uniqueKey":"disabled_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Why a disabled endpoint is disabled: `manual` (PATCH) or `failing` (deliveries kept failing). Null while enabled.","isRequired":true,"uniqueKey":"disabled_reason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"disabled_reason","typeLabel":"enum\u003cstring> | null"},"created_at":{"type":"string","description":"When the endpoint was created (ISO 8601, UTC).","isRequired":true,"uniqueKey":"created_at","typeLabel":"string"},"secret":{"type":"string","description":"The signing secret (`whsec_...`). Shown once, in this answer; store it to verify deliveries.","isRequired":true,"uniqueKey":"secret","typeLabel":"string"}},"required":["object","id","url","description","event_types","shop_ids","status","disabled_reason","created_at","secret"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"object":"webhook_endpoint","id":"we_01JMOCK0000000000000000000","url":"https://example.com/alura/webhooks","description":"Order notifications","event_types":["order.*"],"shop_ids":null,"status":"enabled","disabled_reason":null,"created_at":"2026-10-22T09:00:00.000Z","secret":"whsec_ExampleExampleExampleExampleExampleExam0="},"examples":{"Example":{"title":"Example","value":{"object":"webhook_endpoint","id":"we_01JMOCK0000000000000000000","url":"https://example.com/alura/webhooks","description":"Order notifications","event_types":["order.*"],"shop_ids":null,"status":"enabled","disabled_reason":null,"created_at":"2026-10-22T09:00:00.000Z","secret":"whsec_ExampleExampleExampleExampleExampleExam0="}}},"exampleType":"examples"}},"exampleType":"examples"},"3f463acb-3a48-4657-a3be-025e821323cc":{"description":"Error","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details.","properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","description":"A code from the error catalog; new codes may be added.","x-extensible-enum":["invalid_request","unknown_parameter","invalid_cursor","cursor_window_exceeded","invalid_reference","id_type_mismatch","invalid_keyword","shop_id_required","listing_not_publishable","sales_window_not_covered","unauthorized","credits_exhausted","plan_required","insufficient_scope","workspace_required","workspace_locked","your_shop_unavailable","writes_suspended","browser_refused","role_required","impersonation_refused","recent_sign_in_required","etsy_scope_required","etsy_partner_required","not_found","not_collected","not_found_on_etsy","shop_opted_out","method_not_allowed","conflict","key_limit_reached","reconnect_required","settings_not_fetched","listing_busy","settings_busy","shop_create_busy","idempotency_partial_unverifiable","listing_has_variations","changed_since","change_not_revertable","listing_in_ab_test","activation_skipped","idempotency_processing","confirmation_required","test_shop_active_cap","write_outcome_unknown","unprocessable","listing_removed_on_etsy","endpoint_removed","rate_limited","throttled","daily_credit_cap_exceeded","credits_reserved","fetch_limit_reached","write_rate_limited","sync_cooldown","shop_write_budget_exhausted","internal_error","write_misconfigured","upstream_unavailable","credits_unavailable","service_unavailable","fetch_unavailable","create_lock_unavailable","writes_paused","etsy_capacity","upstream_timeout"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"suggestion":{"type":"string","isRequired":true,"uniqueKey":"suggestion","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"upgrade_url":{"type":"string","format":"uri","description":"credits_exhausted and plan_required: where to upgrade the plan.","uniqueKey":"upgrade_url","typeLabel":"string\u003curi>"},"credits_needed":{"type":"integer","description":"API credit refusals: what the call needed.","uniqueKey":"credits_needed","typeLabel":"integer"},"credits_remaining":{"type":"integer","description":"API credit refusals: what is left (of the month, or of the day for daily_credit_cap_exceeded).","uniqueKey":"credits_remaining","typeLabel":"integer"},"resets_at":{"type":"string","format":"date-time","description":"credits_exhausted and daily_credit_cap_exceeded: when the limit resets.","uniqueKey":"resets_at","typeLabel":"string\u003cdate-time>"}},"required":["type","title","status","code","detail","suggestion","retryable","request_id"],"uniqueKey":"","typeLabel":"object"},"example":{"type":"https://docs.alura.io/errors/invalid_request","title":"Invalid request","status":400,"code":"invalid_request","detail":"Invalid request","suggestion":"Fix the request as the detail says, then send it again.","retryable":false,"request_id":"req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"},"examples":{"Example":{"title":"Example","value":{"type":"https://docs.alura.io/errors/invalid_request","title":"Invalid request","status":400,"code":"invalid_request","detail":"Invalid request","suggestion":"Fix the request as the detail says, then send it again.","retryable":false,"request_id":"req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"}}},"exampleType":"examples"}},"exampleType":"examples"},"18c112d1-1393-4ae4-a6ee-a0f750da585d":{"description":"Error","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details.","properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","description":"A code from the error catalog; new codes may be added.","x-extensible-enum":["invalid_request","unknown_parameter","invalid_cursor","cursor_window_exceeded","invalid_reference","id_type_mismatch","invalid_keyword","shop_id_required","listing_not_publishable","sales_window_not_covered","unauthorized","credits_exhausted","plan_required","insufficient_scope","workspace_required","workspace_locked","your_shop_unavailable","writes_suspended","browser_refused","role_required","impersonation_refused","recent_sign_in_required","etsy_scope_required","etsy_partner_required","not_found","not_collected","not_found_on_etsy","shop_opted_out","method_not_allowed","conflict","key_limit_reached","reconnect_required","settings_not_fetched","listing_busy","settings_busy","shop_create_busy","idempotency_partial_unverifiable","listing_has_variations","changed_since","change_not_revertable","listing_in_ab_test","activation_skipped","idempotency_processing","confirmation_required","test_shop_active_cap","write_outcome_unknown","unprocessable","listing_removed_on_etsy","endpoint_removed","rate_limited","throttled","daily_credit_cap_exceeded","credits_reserved","fetch_limit_reached","write_rate_limited","sync_cooldown","shop_write_budget_exhausted","internal_error","write_misconfigured","upstream_unavailable","credits_unavailable","service_unavailable","fetch_unavailable","create_lock_unavailable","writes_paused","etsy_capacity","upstream_timeout"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"suggestion":{"type":"string","isRequired":true,"uniqueKey":"suggestion","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"upgrade_url":{"type":"string","format":"uri","description":"credits_exhausted and plan_required: where to upgrade the plan.","uniqueKey":"upgrade_url","typeLabel":"string\u003curi>"},"credits_needed":{"type":"integer","description":"API credit refusals: what the call needed.","uniqueKey":"credits_needed","typeLabel":"integer"},"credits_remaining":{"type":"integer","description":"API credit refusals: what is left (of the month, or of the day for daily_credit_cap_exceeded).","uniqueKey":"credits_remaining","typeLabel":"integer"},"resets_at":{"type":"string","format":"date-time","description":"credits_exhausted and daily_credit_cap_exceeded: when the limit resets.","uniqueKey":"resets_at","typeLabel":"string\u003cdate-time>"}},"required":["type","title","status","code","detail","suggestion","retryable","request_id"],"uniqueKey":"","typeLabel":"object"},"example":{"type":"https://docs.alura.io/errors/unauthorized","title":"Unauthorized","status":401,"code":"unauthorized","detail":"Unauthorized","suggestion":"Send a valid API key as `Authorization: Bearer alura_sk_...`.","retryable":false,"request_id":"req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"},"examples":{"Example":{"title":"Example","value":{"type":"https://docs.alura.io/errors/unauthorized","title":"Unauthorized","status":401,"code":"unauthorized","detail":"Unauthorized","suggestion":"Send a valid API key as `Authorization: Bearer alura_sk_...`.","retryable":false,"request_id":"req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"}}},"exampleType":"examples"}},"exampleType":"examples"},"743ed0e7-caf9-4eef-9565-489f37e26aff":{"description":"Error","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details.","properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","description":"A code from the error catalog; new codes may be added.","x-extensible-enum":["invalid_request","unknown_parameter","invalid_cursor","cursor_window_exceeded","invalid_reference","id_type_mismatch","invalid_keyword","shop_id_required","listing_not_publishable","sales_window_not_covered","unauthorized","credits_exhausted","plan_required","insufficient_scope","workspace_required","workspace_locked","your_shop_unavailable","writes_suspended","browser_refused","role_required","impersonation_refused","recent_sign_in_required","etsy_scope_required","etsy_partner_required","not_found","not_collected","not_found_on_etsy","shop_opted_out","method_not_allowed","conflict","key_limit_reached","reconnect_required","settings_not_fetched","listing_busy","settings_busy","shop_create_busy","idempotency_partial_unverifiable","listing_has_variations","changed_since","change_not_revertable","listing_in_ab_test","activation_skipped","idempotency_processing","confirmation_required","test_shop_active_cap","write_outcome_unknown","unprocessable","listing_removed_on_etsy","endpoint_removed","rate_limited","throttled","daily_credit_cap_exceeded","credits_reserved","fetch_limit_reached","write_rate_limited","sync_cooldown","shop_write_budget_exhausted","internal_error","write_misconfigured","upstream_unavailable","credits_unavailable","service_unavailable","fetch_unavailable","create_lock_unavailable","writes_paused","etsy_capacity","upstream_timeout"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"suggestion":{"type":"string","isRequired":true,"uniqueKey":"suggestion","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"upgrade_url":{"type":"string","format":"uri","description":"credits_exhausted and plan_required: where to upgrade the plan.","uniqueKey":"upgrade_url","typeLabel":"string\u003curi>"},"credits_needed":{"type":"integer","description":"API credit refusals: what the call needed.","uniqueKey":"credits_needed","typeLabel":"integer"},"credits_remaining":{"type":"integer","description":"API credit refusals: what is left (of the month, or of the day for daily_credit_cap_exceeded).","uniqueKey":"credits_remaining","typeLabel":"integer"},"resets_at":{"type":"string","format":"date-time","description":"credits_exhausted and daily_credit_cap_exceeded: when the limit resets.","uniqueKey":"resets_at","typeLabel":"string\u003cdate-time>"}},"required":["type","title","status","code","detail","suggestion","retryable","request_id"],"uniqueKey":"","typeLabel":"object"},"example":{"type":"https://docs.alura.io/errors/credits_exhausted","title":"API credits exhausted","status":402,"code":"credits_exhausted","detail":"API credits exhausted","suggestion":"Upgrade the plan or wait for the monthly reset.","retryable":false,"request_id":"req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"},"examples":{"Example":{"title":"Example","value":{"type":"https://docs.alura.io/errors/credits_exhausted","title":"API credits exhausted","status":402,"code":"credits_exhausted","detail":"API credits exhausted","suggestion":"Upgrade the plan or wait for the monthly reset.","retryable":false,"request_id":"req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"}}},"exampleType":"examples"}},"exampleType":"examples"},"309fb847-2f5f-4e69-9073-1488105460af":{"description":"Error","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details.","properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","description":"A code from the error catalog; new codes may be added.","x-extensible-enum":["invalid_request","unknown_parameter","invalid_cursor","cursor_window_exceeded","invalid_reference","id_type_mismatch","invalid_keyword","shop_id_required","listing_not_publishable","sales_window_not_covered","unauthorized","credits_exhausted","plan_required","insufficient_scope","workspace_required","workspace_locked","your_shop_unavailable","writes_suspended","browser_refused","role_required","impersonation_refused","recent_sign_in_required","etsy_scope_required","etsy_partner_required","not_found","not_collected","not_found_on_etsy","shop_opted_out","method_not_allowed","conflict","key_limit_reached","reconnect_required","settings_not_fetched","listing_busy","settings_busy","shop_create_busy","idempotency_partial_unverifiable","listing_has_variations","changed_since","change_not_revertable","listing_in_ab_test","activation_skipped","idempotency_processing","confirmation_required","test_shop_active_cap","write_outcome_unknown","unprocessable","listing_removed_on_etsy","endpoint_removed","rate_limited","throttled","daily_credit_cap_exceeded","credits_reserved","fetch_limit_reached","write_rate_limited","sync_cooldown","shop_write_budget_exhausted","internal_error","write_misconfigured","upstream_unavailable","credits_unavailable","service_unavailable","fetch_unavailable","create_lock_unavailable","writes_paused","etsy_capacity","upstream_timeout"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"suggestion":{"type":"string","isRequired":true,"uniqueKey":"suggestion","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"upgrade_url":{"type":"string","format":"uri","description":"credits_exhausted and plan_required: where to upgrade the plan.","uniqueKey":"upgrade_url","typeLabel":"string\u003curi>"},"credits_needed":{"type":"integer","description":"API credit refusals: what the call needed.","uniqueKey":"credits_needed","typeLabel":"integer"},"credits_remaining":{"type":"integer","description":"API credit refusals: what is left (of the month, or of the day for daily_credit_cap_exceeded).","uniqueKey":"credits_remaining","typeLabel":"integer"},"resets_at":{"type":"string","format":"date-time","description":"credits_exhausted and daily_credit_cap_exceeded: when the limit resets.","uniqueKey":"resets_at","typeLabel":"string\u003cdate-time>"}},"required":["type","title","status","code","detail","suggestion","retryable","request_id"],"uniqueKey":"","typeLabel":"object"},"example":{"type":"https://docs.alura.io/errors/plan_required","title":"Plan required","status":403,"code":"plan_required","detail":"Plan required","suggestion":"Upgrade the workspace plan to use this operation.","retryable":false,"request_id":"req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"},"examples":{"Example":{"title":"Example","value":{"type":"https://docs.alura.io/errors/plan_required","title":"Plan required","status":403,"code":"plan_required","detail":"Plan required","suggestion":"Upgrade the workspace plan to use this operation.","retryable":false,"request_id":"req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"}}},"exampleType":"examples"}},"exampleType":"examples"},"9460062e-b257-43dc-bf3e-9ddb0aaf0188":{"description":"Error","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details.","properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","description":"A code from the error catalog; new codes may be added.","x-extensible-enum":["invalid_request","unknown_parameter","invalid_cursor","cursor_window_exceeded","invalid_reference","id_type_mismatch","invalid_keyword","shop_id_required","listing_not_publishable","sales_window_not_covered","unauthorized","credits_exhausted","plan_required","insufficient_scope","workspace_required","workspace_locked","your_shop_unavailable","writes_suspended","browser_refused","role_required","impersonation_refused","recent_sign_in_required","etsy_scope_required","etsy_partner_required","not_found","not_collected","not_found_on_etsy","shop_opted_out","method_not_allowed","conflict","key_limit_reached","reconnect_required","settings_not_fetched","listing_busy","settings_busy","shop_create_busy","idempotency_partial_unverifiable","listing_has_variations","changed_since","change_not_revertable","listing_in_ab_test","activation_skipped","idempotency_processing","confirmation_required","test_shop_active_cap","write_outcome_unknown","unprocessable","listing_removed_on_etsy","endpoint_removed","rate_limited","throttled","daily_credit_cap_exceeded","credits_reserved","fetch_limit_reached","write_rate_limited","sync_cooldown","shop_write_budget_exhausted","internal_error","write_misconfigured","upstream_unavailable","credits_unavailable","service_unavailable","fetch_unavailable","create_lock_unavailable","writes_paused","etsy_capacity","upstream_timeout"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"suggestion":{"type":"string","isRequired":true,"uniqueKey":"suggestion","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"upgrade_url":{"type":"string","format":"uri","description":"credits_exhausted and plan_required: where to upgrade the plan.","uniqueKey":"upgrade_url","typeLabel":"string\u003curi>"},"credits_needed":{"type":"integer","description":"API credit refusals: what the call needed.","uniqueKey":"credits_needed","typeLabel":"integer"},"credits_remaining":{"type":"integer","description":"API credit refusals: what is left (of the month, or of the day for daily_credit_cap_exceeded).","uniqueKey":"credits_remaining","typeLabel":"integer"},"resets_at":{"type":"string","format":"date-time","description":"credits_exhausted and daily_credit_cap_exceeded: when the limit resets.","uniqueKey":"resets_at","typeLabel":"string\u003cdate-time>"}},"required":["type","title","status","code","detail","suggestion","retryable","request_id"],"uniqueKey":"","typeLabel":"object"},"example":{"type":"https://docs.alura.io/errors/not_found","title":"Not found","status":404,"code":"not_found","detail":"Not found","suggestion":"Check the ID, or search for it first.","retryable":false,"request_id":"req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"},"examples":{"Example":{"title":"Example","value":{"type":"https://docs.alura.io/errors/not_found","title":"Not found","status":404,"code":"not_found","detail":"Not found","suggestion":"Check the ID, or search for it first.","retryable":false,"request_id":"req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"}}},"exampleType":"examples"}},"exampleType":"examples"},"8bc61d83-cce2-4449-9a31-4b25dae632c7":{"description":"Error","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details.","properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","description":"A code from the error catalog; new codes may be added.","x-extensible-enum":["invalid_request","unknown_parameter","invalid_cursor","cursor_window_exceeded","invalid_reference","id_type_mismatch","invalid_keyword","shop_id_required","listing_not_publishable","sales_window_not_covered","unauthorized","credits_exhausted","plan_required","insufficient_scope","workspace_required","workspace_locked","your_shop_unavailable","writes_suspended","browser_refused","role_required","impersonation_refused","recent_sign_in_required","etsy_scope_required","etsy_partner_required","not_found","not_collected","not_found_on_etsy","shop_opted_out","method_not_allowed","conflict","key_limit_reached","reconnect_required","settings_not_fetched","listing_busy","settings_busy","shop_create_busy","idempotency_partial_unverifiable","listing_has_variations","changed_since","change_not_revertable","listing_in_ab_test","activation_skipped","idempotency_processing","confirmation_required","test_shop_active_cap","write_outcome_unknown","unprocessable","listing_removed_on_etsy","endpoint_removed","rate_limited","throttled","daily_credit_cap_exceeded","credits_reserved","fetch_limit_reached","write_rate_limited","sync_cooldown","shop_write_budget_exhausted","internal_error","write_misconfigured","upstream_unavailable","credits_unavailable","service_unavailable","fetch_unavailable","create_lock_unavailable","writes_paused","etsy_capacity","upstream_timeout"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"suggestion":{"type":"string","isRequired":true,"uniqueKey":"suggestion","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"upgrade_url":{"type":"string","format":"uri","description":"credits_exhausted and plan_required: where to upgrade the plan.","uniqueKey":"upgrade_url","typeLabel":"string\u003curi>"},"credits_needed":{"type":"integer","description":"API credit refusals: what the call needed.","uniqueKey":"credits_needed","typeLabel":"integer"},"credits_remaining":{"type":"integer","description":"API credit refusals: what is left (of the month, or of the day for daily_credit_cap_exceeded).","uniqueKey":"credits_remaining","typeLabel":"integer"},"resets_at":{"type":"string","format":"date-time","description":"credits_exhausted and daily_credit_cap_exceeded: when the limit resets.","uniqueKey":"resets_at","typeLabel":"string\u003cdate-time>"}},"required":["type","title","status","code","detail","suggestion","retryable","request_id"],"uniqueKey":"","typeLabel":"object"},"example":{"type":"https://docs.alura.io/errors/method_not_allowed","title":"Method not allowed","status":405,"code":"method_not_allowed","detail":"Method not allowed","suggestion":"Use one of the methods in the Allow header.","retryable":false,"request_id":"req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"},"examples":{"Example":{"title":"Example","value":{"type":"https://docs.alura.io/errors/method_not_allowed","title":"Method not allowed","status":405,"code":"method_not_allowed","detail":"Method not allowed","suggestion":"Use one of the methods in the Allow header.","retryable":false,"request_id":"req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"}}},"exampleType":"examples"}},"exampleType":"examples"},"ac62971f-86f3-43e3-937d-e995707ae867":{"description":"Error","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details.","properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","description":"A code from the error catalog; new codes may be added.","x-extensible-enum":["invalid_request","unknown_parameter","invalid_cursor","cursor_window_exceeded","invalid_reference","id_type_mismatch","invalid_keyword","shop_id_required","listing_not_publishable","sales_window_not_covered","unauthorized","credits_exhausted","plan_required","insufficient_scope","workspace_required","workspace_locked","your_shop_unavailable","writes_suspended","browser_refused","role_required","impersonation_refused","recent_sign_in_required","etsy_scope_required","etsy_partner_required","not_found","not_collected","not_found_on_etsy","shop_opted_out","method_not_allowed","conflict","key_limit_reached","reconnect_required","settings_not_fetched","listing_busy","settings_busy","shop_create_busy","idempotency_partial_unverifiable","listing_has_variations","changed_since","change_not_revertable","listing_in_ab_test","activation_skipped","idempotency_processing","confirmation_required","test_shop_active_cap","write_outcome_unknown","unprocessable","listing_removed_on_etsy","endpoint_removed","rate_limited","throttled","daily_credit_cap_exceeded","credits_reserved","fetch_limit_reached","write_rate_limited","sync_cooldown","shop_write_budget_exhausted","internal_error","write_misconfigured","upstream_unavailable","credits_unavailable","service_unavailable","fetch_unavailable","create_lock_unavailable","writes_paused","etsy_capacity","upstream_timeout"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"suggestion":{"type":"string","isRequired":true,"uniqueKey":"suggestion","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"upgrade_url":{"type":"string","format":"uri","description":"credits_exhausted and plan_required: where to upgrade the plan.","uniqueKey":"upgrade_url","typeLabel":"string\u003curi>"},"credits_needed":{"type":"integer","description":"API credit refusals: what the call needed.","uniqueKey":"credits_needed","typeLabel":"integer"},"credits_remaining":{"type":"integer","description":"API credit refusals: what is left (of the month, or of the day for daily_credit_cap_exceeded).","uniqueKey":"credits_remaining","typeLabel":"integer"},"resets_at":{"type":"string","format":"date-time","description":"credits_exhausted and daily_credit_cap_exceeded: when the limit resets.","uniqueKey":"resets_at","typeLabel":"string\u003cdate-time>"}},"required":["type","title","status","code","detail","suggestion","retryable","request_id"],"uniqueKey":"","typeLabel":"object"},"example":{"type":"https://docs.alura.io/errors/conflict","title":"Conflict","status":409,"code":"conflict","detail":"Conflict","suggestion":"Reload the resource and retry with its current state.","retryable":false,"request_id":"req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"},"examples":{"Example":{"title":"Example","value":{"type":"https://docs.alura.io/errors/conflict","title":"Conflict","status":409,"code":"conflict","detail":"Conflict","suggestion":"Reload the resource and retry with its current state.","retryable":false,"request_id":"req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"}}},"exampleType":"examples"}},"exampleType":"examples"},"d91c6b41-7535-4530-9b02-ec31306d0b2a":{"description":"Error","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details.","properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","description":"A code from the error catalog; new codes may be added.","x-extensible-enum":["invalid_request","unknown_parameter","invalid_cursor","cursor_window_exceeded","invalid_reference","id_type_mismatch","invalid_keyword","shop_id_required","listing_not_publishable","sales_window_not_covered","unauthorized","credits_exhausted","plan_required","insufficient_scope","workspace_required","workspace_locked","your_shop_unavailable","writes_suspended","browser_refused","role_required","impersonation_refused","recent_sign_in_required","etsy_scope_required","etsy_partner_required","not_found","not_collected","not_found_on_etsy","shop_opted_out","method_not_allowed","conflict","key_limit_reached","reconnect_required","settings_not_fetched","listing_busy","settings_busy","shop_create_busy","idempotency_partial_unverifiable","listing_has_variations","changed_since","change_not_revertable","listing_in_ab_test","activation_skipped","idempotency_processing","confirmation_required","test_shop_active_cap","write_outcome_unknown","unprocessable","listing_removed_on_etsy","endpoint_removed","rate_limited","throttled","daily_credit_cap_exceeded","credits_reserved","fetch_limit_reached","write_rate_limited","sync_cooldown","shop_write_budget_exhausted","internal_error","write_misconfigured","upstream_unavailable","credits_unavailable","service_unavailable","fetch_unavailable","create_lock_unavailable","writes_paused","etsy_capacity","upstream_timeout"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"suggestion":{"type":"string","isRequired":true,"uniqueKey":"suggestion","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"upgrade_url":{"type":"string","format":"uri","description":"credits_exhausted and plan_required: where to upgrade the plan.","uniqueKey":"upgrade_url","typeLabel":"string\u003curi>"},"credits_needed":{"type":"integer","description":"API credit refusals: what the call needed.","uniqueKey":"credits_needed","typeLabel":"integer"},"credits_remaining":{"type":"integer","description":"API credit refusals: what is left (of the month, or of the day for daily_credit_cap_exceeded).","uniqueKey":"credits_remaining","typeLabel":"integer"},"resets_at":{"type":"string","format":"date-time","description":"credits_exhausted and daily_credit_cap_exceeded: when the limit resets.","uniqueKey":"resets_at","typeLabel":"string\u003cdate-time>"}},"required":["type","title","status","code","detail","suggestion","retryable","request_id"],"uniqueKey":"","typeLabel":"object"},"example":{"type":"https://docs.alura.io/errors/rate_limited","title":"Rate limited","status":429,"code":"rate_limited","detail":"Rate limited","suggestion":"Wait for Retry-After, then retry.","retryable":true,"request_id":"req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"},"examples":{"Example":{"title":"Example","value":{"type":"https://docs.alura.io/errors/rate_limited","title":"Rate limited","status":429,"code":"rate_limited","detail":"Rate limited","suggestion":"Wait for Retry-After, then retry.","retryable":true,"request_id":"req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"}}},"exampleType":"examples"}},"exampleType":"examples"},"63fa4004-2674-4b8e-a3e2-a4d70868d531":{"description":"Error","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details.","properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","description":"A code from the error catalog; new codes may be added.","x-extensible-enum":["invalid_request","unknown_parameter","invalid_cursor","cursor_window_exceeded","invalid_reference","id_type_mismatch","invalid_keyword","shop_id_required","listing_not_publishable","sales_window_not_covered","unauthorized","credits_exhausted","plan_required","insufficient_scope","workspace_required","workspace_locked","your_shop_unavailable","writes_suspended","browser_refused","role_required","impersonation_refused","recent_sign_in_required","etsy_scope_required","etsy_partner_required","not_found","not_collected","not_found_on_etsy","shop_opted_out","method_not_allowed","conflict","key_limit_reached","reconnect_required","settings_not_fetched","listing_busy","settings_busy","shop_create_busy","idempotency_partial_unverifiable","listing_has_variations","changed_since","change_not_revertable","listing_in_ab_test","activation_skipped","idempotency_processing","confirmation_required","test_shop_active_cap","write_outcome_unknown","unprocessable","listing_removed_on_etsy","endpoint_removed","rate_limited","throttled","daily_credit_cap_exceeded","credits_reserved","fetch_limit_reached","write_rate_limited","sync_cooldown","shop_write_budget_exhausted","internal_error","write_misconfigured","upstream_unavailable","credits_unavailable","service_unavailable","fetch_unavailable","create_lock_unavailable","writes_paused","etsy_capacity","upstream_timeout"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"suggestion":{"type":"string","isRequired":true,"uniqueKey":"suggestion","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"upgrade_url":{"type":"string","format":"uri","description":"credits_exhausted and plan_required: where to upgrade the plan.","uniqueKey":"upgrade_url","typeLabel":"string\u003curi>"},"credits_needed":{"type":"integer","description":"API credit refusals: what the call needed.","uniqueKey":"credits_needed","typeLabel":"integer"},"credits_remaining":{"type":"integer","description":"API credit refusals: what is left (of the month, or of the day for daily_credit_cap_exceeded).","uniqueKey":"credits_remaining","typeLabel":"integer"},"resets_at":{"type":"string","format":"date-time","description":"credits_exhausted and daily_credit_cap_exceeded: when the limit resets.","uniqueKey":"resets_at","typeLabel":"string\u003cdate-time>"}},"required":["type","title","status","code","detail","suggestion","retryable","request_id"],"uniqueKey":"","typeLabel":"object"},"example":{"type":"https://docs.alura.io/errors/internal_error","title":"Internal error","status":500,"code":"internal_error","detail":"Internal error","suggestion":"Retry; if it keeps failing, report the request_id.","retryable":true,"request_id":"req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"},"examples":{"Example":{"title":"Example","value":{"type":"https://docs.alura.io/errors/internal_error","title":"Internal error","status":500,"code":"internal_error","detail":"Internal error","suggestion":"Retry; if it keeps failing, report the request_id.","retryable":true,"request_id":"req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"}}},"exampleType":"examples"}},"exampleType":"examples"},"3006dee7-2a7a-4911-817d-6821fc55ee02":{"description":"Error","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details.","properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"code":{"type":"string","description":"A code from the error catalog; new codes may be added.","x-extensible-enum":["invalid_request","unknown_parameter","invalid_cursor","cursor_window_exceeded","invalid_reference","id_type_mismatch","invalid_keyword","shop_id_required","listing_not_publishable","sales_window_not_covered","unauthorized","credits_exhausted","plan_required","insufficient_scope","workspace_required","workspace_locked","your_shop_unavailable","writes_suspended","browser_refused","role_required","impersonation_refused","recent_sign_in_required","etsy_scope_required","etsy_partner_required","not_found","not_collected","not_found_on_etsy","shop_opted_out","method_not_allowed","conflict","key_limit_reached","reconnect_required","settings_not_fetched","listing_busy","settings_busy","shop_create_busy","idempotency_partial_unverifiable","listing_has_variations","changed_since","change_not_revertable","listing_in_ab_test","activation_skipped","idempotency_processing","confirmation_required","test_shop_active_cap","write_outcome_unknown","unprocessable","listing_removed_on_etsy","endpoint_removed","rate_limited","throttled","daily_credit_cap_exceeded","credits_reserved","fetch_limit_reached","write_rate_limited","sync_cooldown","shop_write_budget_exhausted","internal_error","write_misconfigured","upstream_unavailable","credits_unavailable","service_unavailable","fetch_unavailable","create_lock_unavailable","writes_paused","etsy_capacity","upstream_timeout"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"suggestion":{"type":"string","isRequired":true,"uniqueKey":"suggestion","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"retryable","typeLabel":"boolean"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"upgrade_url":{"type":"string","format":"uri","description":"credits_exhausted and plan_required: where to upgrade the plan.","uniqueKey":"upgrade_url","typeLabel":"string\u003curi>"},"credits_needed":{"type":"integer","description":"API credit refusals: what the call needed.","uniqueKey":"credits_needed","typeLabel":"integer"},"credits_remaining":{"type":"integer","description":"API credit refusals: what is left (of the month, or of the day for daily_credit_cap_exceeded).","uniqueKey":"credits_remaining","typeLabel":"integer"},"resets_at":{"type":"string","format":"date-time","description":"credits_exhausted and daily_credit_cap_exceeded: when the limit resets.","uniqueKey":"resets_at","typeLabel":"string\u003cdate-time>"}},"required":["type","title","status","code","detail","suggestion","retryable","request_id"],"uniqueKey":"","typeLabel":"object"},"example":{"type":"https://docs.alura.io/errors/credits_unavailable","title":"API credits unavailable","status":503,"code":"credits_unavailable","detail":"API credits unavailable","suggestion":"Retry shortly.","retryable":true,"request_id":"req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"},"examples":{"Example":{"title":"Example","value":{"type":"https://docs.alura.io/errors/credits_unavailable","title":"API credits unavailable","status":503,"code":"credits_unavailable","detail":"API credits unavailable","suggestion":"Retry shortly.","retryable":true,"request_id":"req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"6144536c-06b0-4b8d-affd-b8dccec7d5ee":{"apiKey":{"type":"http","scheme":"bearer","description":"An API key: `Authorization: Bearer alura_sk_...`.","scopes":[],"schemeName":"apiKey"}}},"servers":{"6c764af2-fbc8-469e-a5ff-745270cc266b":{"url":"https://api.alura.io"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An API key: `Authorization: Bearer alura_sk_...`.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key: `Authorization: Bearer alura_sk_...`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"openapi.json"},"subdomain":"alura","siteName":"Alura API","title":"Rotate secret - Alura API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-07T16:18:24.136Z","originalFileLocation":"api-reference/webhooks/endpoints/rotatesecret.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=\"Replace a webhook endpoint\u0026#x27;s signing secret. The old secret keeps signing for 24 hours, so you can switch your verifier without missing a delivery.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Alura API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/alura/Zo6rWRwbAxOIKIxc/_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/alura/Zo6rWRwbAxOIKIxc/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/alura/Zo6rWRwbAxOIKIxc/_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/alura/Zo6rWRwbAxOIKIxc/_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/alura/Zo6rWRwbAxOIKIxc/_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/alura/Zo6rWRwbAxOIKIxc/_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/alura/Zo6rWRwbAxOIKIxc/_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/alura/Zo6rWRwbAxOIKIxc/_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/alura/Zo6rWRwbAxOIKIxc/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Rotate secret - Alura API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Replace a webhook endpoint\u0026#x27;s signing secret. The old secret keeps signing for 24 hours, so you can switch your verifier without missing a delivery.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Alura API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.alura.io/api-reference/webhooks/endpoints/rotatesecret\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://alura.mintlify.site/_mintlify/api/og/v2?division=Webhook+endpoints\u0026amp;title=Rotate+secret\u0026amp;description=Replace+a+webhook+endpoint%27s+signing+secret.+The+old+secret+keeps+signing+for+24+hours%2C+so+you+can+switch+your+verifier+without+missing+a+delivery.\u0026amp;theme=3c07f090342beadd77468265\u0026amp;signature=e4068b9a2d4b96267e244136e5dbe39bed99cf703ac9acf1fab86de3387b28ce\">\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=\"Rotate secret - Alura API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Replace a webhook endpoint\u0026#x27;s signing secret. The old secret keeps signing for 24 hours, so you can switch your verifier without missing a delivery.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://alura.mintlify.site/_mintlify/api/og/v2?division=Webhook+endpoints\u0026amp;title=Rotate+secret\u0026amp;description=Replace+a+webhook+endpoint%27s+signing+secret.+The+old+secret+keeps+signing+for+24+hours%2C+so+you+can+switch+your+verifier+without+missing+a+delivery.\u0026amp;theme=3c07f090342beadd77468265\u0026amp;signature=e4068b9a2d4b96267e244136e5dbe39bed99cf703ac9acf1fab86de3387b28ce\">\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/alura/Zo6rWRwbAxOIKIxc/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Alura API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#155EEF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.alura.io/api-reference/webhooks/endpoints/rotatesecret\">\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/endpoints/rotatesecret.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.alura.io/#organization\",\"name\":\"Alura API\",\"url\":\"https://docs.alura.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/alura/HySS5CT36sWBL9EL/logo/light.svg?fit=max\u0026auto=format\u0026n=HySS5CT36sWBL9EL\u0026q=85\u0026s=6afcc5174d02ee0af4c233126964240a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.alura.io#website\",\"name\":\"Alura API\",\"url\":\"https://docs.alura.io\",\"publisher\":{\"@id\":\"https://docs.alura.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.alura.io/api-reference/webhooks/endpoints/rotatesecret#webpage\",\"url\":\"https://docs.alura.io/api-reference/webhooks/endpoints/rotatesecret\",\"name\":\"Rotate secret\",\"description\":\"Replace a webhook endpoint's signing secret. The old secret keeps signing for 24 hours, so you can switch your verifier without missing a delivery.\",\"dateModified\":\"2026-11-07T16:18:24.136Z\",\"isPartOf\":{\"@id\":\"https://docs.alura.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.alura.io/api-reference/webhooks/endpoints/rotatesecret#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.alura.io/api-reference/webhooks/endpoints/rotatesecret#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Webhooks \u0026 events\",\"item\":\"https://docs.alura.io/api-reference/webhooks/endpoints/create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Webhook endpoints\",\"item\":\"https://docs.alura.io/api-reference/webhooks/endpoints/create\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Rotate secret\",\"item\":\"https://docs.alura.io/api-reference/webhooks/endpoints/rotatesecret\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.alura.io/api-reference/webhooks/endpoints/rotatesecret#apireference\",\"headline\":\"Rotate secret\",\"name\":\"Rotate secret\",\"description\":\"Replace a webhook endpoint's signing secret. The old secret keeps signing for 24 hours, so you can switch your verifier without missing a delivery.\",\"url\":\"https://docs.alura.io/api-reference/webhooks/endpoints/rotatesecret\",\"mainEntityOfPage\":{\"@id\":\"https://docs.alura.io/api-reference/webhooks/endpoints/rotatesecret#webpage\"},\"dateModified\":\"2026-11-07T16:18:24.136Z\",\"publisher\":{\"@id\":\"https://docs.alura.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.alura.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Alura API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Alura API","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Credits and limits","href":"/api-reference/credits-and-limits"},{"title":"Errors","href":"/api-reference/errors"}]},{"group":"Research","pages":[{"group":"Lookup","pages":[{"title":"Look up URL or shop","deprecated":null,"version":null,"sidebarTitle":"Look up URL or shop","openapi":"/openapi.json get /v1/research/lookup","href":"/api-reference/research/lookup"}]},{"group":"Products","pages":[{"title":"Search products","deprecated":null,"version":null,"sidebarTitle":"Search products","openapi":"/openapi.json get /v1/research/products","href":"/api-reference/research/products/search"},{"title":"Get trending products","deprecated":null,"version":null,"sidebarTitle":"Get trending products","openapi":"/openapi.json get /v1/research/products/trending","href":"/api-reference/research/products/trending"},{"title":"Get product","deprecated":null,"version":null,"sidebarTitle":"Get product","openapi":"/openapi.json get /v1/research/products/{id}","href":"/api-reference/research/products/get"},{"title":"Get products by ID","openapi":"openapi-variants.json GET /v1/research/products","href":"/api-reference/research/products/getMany"},{"title":"Get similar products","deprecated":null,"version":null,"sidebarTitle":"Get similar products","openapi":"/openapi.json get /v1/research/products/{id}/similar","href":"/api-reference/research/products/similar"},{"title":"Get product history","deprecated":null,"version":null,"sidebarTitle":"Get product history","openapi":"/openapi.json get /v1/research/products/{id}/history","href":"/api-reference/research/products/history"},{"title":"Get sales histories","deprecated":null,"version":null,"sidebarTitle":"Get sales histories","openapi":"/openapi.json get /v1/research/history","href":"/api-reference/research/history/getmany"},{"title":"List product reviews","deprecated":null,"version":null,"sidebarTitle":"List product reviews","openapi":"/openapi.json get /v1/research/products/{id}/reviews","href":"/api-reference/research/products/reviews"}]},{"group":"Shops","pages":[{"title":"Search shops","deprecated":null,"version":null,"sidebarTitle":"Search shops","openapi":"/openapi.json get /v1/research/shops","href":"/api-reference/research/shops/search"},{"title":"Get trending shops","deprecated":null,"version":null,"sidebarTitle":"Get trending shops","openapi":"/openapi.json get /v1/research/shops/trending","href":"/api-reference/research/shops/trending"},{"title":"Get shop","deprecated":null,"version":null,"sidebarTitle":"Get shop","openapi":"/openapi.json get /v1/research/shops/{id}","href":"/api-reference/research/shops/get"},{"title":"List shop products","deprecated":null,"version":null,"sidebarTitle":"List shop products","openapi":"/openapi.json get /v1/research/shops/{id}/products","href":"/api-reference/research/shops/products"},{"title":"Get similar shops","deprecated":null,"version":null,"sidebarTitle":"Get similar shops","openapi":"/openapi.json get /v1/research/shops/{id}/similar","href":"/api-reference/research/shops/similar"},{"title":"List shop reviews","deprecated":null,"version":null,"sidebarTitle":"List shop reviews","openapi":"/openapi.json get /v1/research/shops/{id}/reviews","href":"/api-reference/research/shops/reviews"},{"title":"Get shop history","deprecated":null,"version":null,"sidebarTitle":"Get shop history","openapi":"/openapi.json get /v1/research/shops/{id}/history","href":"/api-reference/research/shops/history"}]},{"group":"Keywords","pages":[{"title":"Look up keywords","deprecated":null,"version":null,"sidebarTitle":"Look up keywords","openapi":"/openapi.json get /v1/research/keywords","href":"/api-reference/research/keywords/lookup"},{"title":"Get trending keywords","deprecated":null,"version":null,"sidebarTitle":"Get trending keywords","openapi":"/openapi.json get /v1/research/keywords/trending","href":"/api-reference/research/keywords/trending"},{"title":"Get keyword","deprecated":null,"version":null,"sidebarTitle":"Get keyword","openapi":"/openapi.json get /v1/research/keywords/{id}","href":"/api-reference/research/keywords/get"},{"title":"Get related keywords","deprecated":null,"version":null,"sidebarTitle":"Get related keywords","openapi":"/openapi.json get /v1/research/keywords/{id}/related","href":"/api-reference/research/keywords/related"},{"title":"Get top products","deprecated":null,"version":null,"sidebarTitle":"Get top products","openapi":"/openapi.json get /v1/research/keywords/{id}/products","href":"/api-reference/research/keywords/products"},{"title":"Get top shops","deprecated":null,"version":null,"sidebarTitle":"Get top shops","openapi":"/openapi.json get /v1/research/keywords/{id}/shops","href":"/api-reference/research/keywords/shops"},{"title":"Get keyword history","deprecated":null,"version":null,"sidebarTitle":"Get keyword history","openapi":"/openapi.json get /v1/research/keywords/{id}/history","href":"/api-reference/research/keywords/history"}]},{"group":"Saved","pages":[{"group":"Folders","pages":[{"title":"List saved folders","deprecated":null,"version":null,"sidebarTitle":"List saved folders","openapi":"/openapi.json get /v1/research/saved/folders","href":"/api-reference/research/saved/folders/list"},{"title":"Create saved folder","deprecated":null,"version":null,"sidebarTitle":"Create saved folder","openapi":"/openapi.json post /v1/research/saved/folders","href":"/api-reference/research/saved/folders/create"},{"title":"Get saved folder","deprecated":null,"version":null,"sidebarTitle":"Get saved folder","openapi":"/openapi.json get /v1/research/saved/folders/{id}","href":"/api-reference/research/saved/folders/get"},{"title":"Update saved folder","deprecated":null,"version":null,"sidebarTitle":"Update saved folder","openapi":"/openapi.json patch /v1/research/saved/folders/{id}","href":"/api-reference/research/saved/folders/update"},{"title":"Delete saved folder","deprecated":null,"version":null,"sidebarTitle":"Delete saved folder","openapi":"/openapi.json delete /v1/research/saved/folders/{id}","href":"/api-reference/research/saved/folders/delete"}]},{"group":"Lists","pages":[{"title":"List saved lists","deprecated":null,"version":null,"sidebarTitle":"List saved lists","openapi":"/openapi.json get /v1/research/saved/lists","href":"/api-reference/research/saved/lists/list"},{"title":"Create saved list","deprecated":null,"version":null,"sidebarTitle":"Create saved list","openapi":"/openapi.json post /v1/research/saved/lists","href":"/api-reference/research/saved/lists/create"},{"title":"Get saved list","deprecated":null,"version":null,"sidebarTitle":"Get saved list","openapi":"/openapi.json get /v1/research/saved/lists/{id}","href":"/api-reference/research/saved/lists/get"},{"title":"Update saved list","deprecated":null,"version":null,"sidebarTitle":"Update saved list","openapi":"/openapi.json patch /v1/research/saved/lists/{id}","href":"/api-reference/research/saved/lists/update"},{"title":"Delete saved list","deprecated":null,"version":null,"sidebarTitle":"Delete saved list","openapi":"/openapi.json delete /v1/research/saved/lists/{id}","href":"/api-reference/research/saved/lists/delete"}]},{"group":"Items","pages":[{"title":"List saved items","deprecated":null,"version":null,"sidebarTitle":"List saved items","openapi":"/openapi.json get /v1/research/saved/lists/{id}/items","href":"/api-reference/research/saved/items/list"},{"title":"List all saved items","deprecated":null,"version":null,"sidebarTitle":"List all saved items","openapi":"/openapi.json get /v1/research/saved/items","href":"/api-reference/research/saved/items/search"},{"title":"Add saved items","deprecated":null,"version":null,"sidebarTitle":"Add saved items","openapi":"/openapi.json post /v1/research/saved/lists/{id}/items","href":"/api-reference/research/saved/items/add"},{"title":"Remove saved items","deprecated":null,"version":null,"sidebarTitle":"Remove saved items","openapi":"/openapi.json delete /v1/research/saved/lists/{id}/items","href":"/api-reference/research/saved/items/remove"}]}]}]},{"group":"Your shop","pages":[{"group":"Shop","pages":[{"title":"List shops","deprecated":null,"version":null,"sidebarTitle":"List shops","openapi":"/openapi.json get /v1/workspace/shops","href":"/api-reference/workspace/shops/list"},{"title":"Get shop","deprecated":null,"version":null,"sidebarTitle":"Get shop","openapi":"/openapi.json get /v1/workspace/shops/{shop_id}","href":"/api-reference/workspace/shops/get"},{"title":"Update shop","deprecated":null,"version":null,"sidebarTitle":"Update shop","openapi":"/openapi.json patch /v1/workspace/shops/{shop_id}","href":"/api-reference/workspace/shops/update"},{"group":"Sections","pages":[{"title":"List sections","deprecated":null,"version":null,"sidebarTitle":"List sections","openapi":"/openapi.json get /v1/workspace/sections","href":"/api-reference/workspace/sections/list"},{"title":"Create section","deprecated":null,"version":null,"sidebarTitle":"Create section","openapi":"/openapi.json post /v1/workspace/sections","href":"/api-reference/workspace/sections/create"},{"title":"Update section","deprecated":null,"version":null,"sidebarTitle":"Update section","openapi":"/openapi.json patch /v1/workspace/sections/{id}","href":"/api-reference/workspace/sections/update"},{"title":"Delete section","deprecated":null,"version":null,"sidebarTitle":"Delete section","openapi":"/openapi.json delete /v1/workspace/sections/{id}","href":"/api-reference/workspace/sections/delete"}]},{"group":"Shipping profiles","pages":[{"title":"List shipping profiles","deprecated":null,"version":null,"sidebarTitle":"List shipping profiles","openapi":"/openapi.json get /v1/workspace/shipping-profiles","href":"/api-reference/workspace/shippingprofiles/list"},{"title":"Get shipping profile","deprecated":null,"version":null,"sidebarTitle":"Get shipping profile","openapi":"/openapi.json get /v1/workspace/shipping-profiles/{id}","href":"/api-reference/workspace/shippingprofiles/get"},{"title":"Create shipping profile","deprecated":null,"version":null,"sidebarTitle":"Create shipping profile","openapi":"/openapi.json post /v1/workspace/shipping-profiles","href":"/api-reference/workspace/shippingprofiles/create"},{"title":"Update shipping profile","deprecated":null,"version":null,"sidebarTitle":"Update shipping profile","openapi":"/openapi.json patch /v1/workspace/shipping-profiles/{id}","href":"/api-reference/workspace/shippingprofiles/update"},{"title":"Delete shipping profile","deprecated":null,"version":null,"sidebarTitle":"Delete shipping profile","openapi":"/openapi.json delete /v1/workspace/shipping-profiles/{id}","href":"/api-reference/workspace/shippingprofiles/delete"},{"group":"Destinations","pages":[{"title":"List destinations","deprecated":null,"version":null,"sidebarTitle":"List destinations","openapi":"/openapi.json get /v1/workspace/shipping-profiles/{id}/destinations","href":"/api-reference/workspace/shippingprofiles/destinations"},{"title":"Create destination","deprecated":null,"version":null,"sidebarTitle":"Create destination","openapi":"/openapi.json post /v1/workspace/shipping-profiles/{id}/destinations","href":"/api-reference/workspace/shippingprofiles/destinations/create"},{"title":"Update destination","deprecated":null,"version":null,"sidebarTitle":"Update destination","openapi":"/openapi.json patch /v1/workspace/shipping-profiles/{id}/destinations/{destination_id}","href":"/api-reference/workspace/shippingprofiles/destinations/update"},{"title":"Delete destination","deprecated":null,"version":null,"sidebarTitle":"Delete destination","openapi":"/openapi.json delete /v1/workspace/shipping-profiles/{id}/destinations/{destination_id}","href":"/api-reference/workspace/shippingprofiles/destinations/delete"}]},{"group":"Upgrades","pages":[{"title":"List delivery upgrades","deprecated":null,"version":null,"sidebarTitle":"List delivery upgrades","openapi":"/openapi.json get /v1/workspace/shipping-profiles/{id}/upgrades","href":"/api-reference/workspace/shippingprofiles/deliveryoptions"},{"title":"Create upgrade","deprecated":null,"version":null,"sidebarTitle":"Create upgrade","openapi":"/openapi.json post /v1/workspace/shipping-profiles/{id}/upgrades","href":"/api-reference/workspace/shippingprofiles/deliveryoptions/create"},{"title":"Update upgrade","deprecated":null,"version":null,"sidebarTitle":"Update upgrade","openapi":"/openapi.json patch /v1/workspace/shipping-profiles/{id}/upgrades/{upgrade_id}","href":"/api-reference/workspace/shippingprofiles/deliveryoptions/update"},{"title":"Delete upgrade","deprecated":null,"version":null,"sidebarTitle":"Delete upgrade","openapi":"/openapi.json delete /v1/workspace/shipping-profiles/{id}/upgrades/{upgrade_id}","href":"/api-reference/workspace/shippingprofiles/deliveryoptions/delete"}]}]},{"group":"Return policies","pages":[{"title":"List return policies","deprecated":null,"version":null,"sidebarTitle":"List return policies","openapi":"/openapi.json get /v1/workspace/return-policies","href":"/api-reference/workspace/returnpolicies/list"},{"title":"Get return policy","deprecated":null,"version":null,"sidebarTitle":"Get return policy","openapi":"/openapi.json get /v1/workspace/return-policies/{id}","href":"/api-reference/workspace/returnpolicies/get"},{"title":"Create return policy","deprecated":null,"version":null,"sidebarTitle":"Create return policy","openapi":"/openapi.json post /v1/workspace/return-policies","href":"/api-reference/workspace/returnpolicies/create"},{"title":"Update return policy","deprecated":null,"version":null,"sidebarTitle":"Update return policy","openapi":"/openapi.json patch /v1/workspace/return-policies/{id}","href":"/api-reference/workspace/returnpolicies/update"},{"title":"Delete return policy","deprecated":null,"version":null,"sidebarTitle":"Delete return policy","openapi":"/openapi.json delete /v1/workspace/return-policies/{id}","href":"/api-reference/workspace/returnpolicies/delete"},{"title":"Move policy listings","deprecated":null,"version":null,"sidebarTitle":"Move policy listings","openapi":"/openapi.json post /v1/workspace/return-policies/{id}/move-listings","href":"/api-reference/workspace/returnpolicies/movelistings"}]},{"group":"Processing profiles","pages":[{"title":"List profiles","deprecated":null,"version":null,"sidebarTitle":"List profiles","openapi":"/openapi.json get /v1/workspace/processing-profiles","href":"/api-reference/workspace/processingprofiles/list"},{"title":"Get profile","deprecated":null,"version":null,"sidebarTitle":"Get profile","openapi":"/openapi.json get /v1/workspace/processing-profiles/{id}","href":"/api-reference/workspace/processingprofiles/get"},{"title":"Create profile","deprecated":null,"version":null,"sidebarTitle":"Create profile","openapi":"/openapi.json post /v1/workspace/processing-profiles","href":"/api-reference/workspace/processingprofiles/create"},{"title":"Update profile","deprecated":null,"version":null,"sidebarTitle":"Update profile","openapi":"/openapi.json patch /v1/workspace/processing-profiles/{id}","href":"/api-reference/workspace/processingprofiles/update"},{"title":"Delete profile","deprecated":null,"version":null,"sidebarTitle":"Delete profile","openapi":"/openapi.json delete /v1/workspace/processing-profiles/{id}","href":"/api-reference/workspace/processingprofiles/delete"}]},{"group":"Holiday settings","pages":[{"title":"Get holiday settings","deprecated":null,"version":null,"sidebarTitle":"Get holiday settings","openapi":"/openapi.json get /v1/workspace/holiday-settings","href":"/api-reference/workspace/holidaysettings/list"},{"title":"Update holiday settings","deprecated":null,"version":null,"sidebarTitle":"Update holiday settings","openapi":"/openapi.json patch /v1/workspace/holiday-settings","href":"/api-reference/workspace/holidaysettings/update"}]},{"group":"Production partners","pages":[{"title":"List partners","deprecated":null,"version":null,"sidebarTitle":"List partners","openapi":"/openapi.json get /v1/workspace/production-partners","href":"/api-reference/workspace/productionpartners/list"}]}]},{"group":"Stats","pages":[{"title":"Get shop stats","deprecated":null,"version":null,"sidebarTitle":"Get shop stats","openapi":"/openapi.json get /v1/workspace/stats","href":"/api-reference/workspace/stats/get"}]},{"group":"Listings","pages":[{"title":"Search listings","deprecated":null,"version":null,"sidebarTitle":"Search listings","openapi":"/openapi.json get /v1/workspace/listings","href":"/api-reference/workspace/listings/search"},{"title":"Get listing","deprecated":null,"version":null,"sidebarTitle":"Get listing","openapi":"/openapi.json get /v1/workspace/listings/{id}","href":"/api-reference/workspace/listings/get"},{"title":"Get listing stats","deprecated":null,"version":null,"sidebarTitle":"Get listing stats","openapi":"/openapi.json get /v1/workspace/listings/{id}/stats","href":"/api-reference/workspace/listings/stats"},{"title":"Update listing","deprecated":null,"version":null,"sidebarTitle":"Update listing","openapi":"/openapi.json patch /v1/workspace/listings/{id}","href":"/api-reference/workspace/listings/update"},{"title":"Create listing","deprecated":null,"version":null,"sidebarTitle":"Create listing","openapi":"/openapi.json post /v1/workspace/listings","href":"/api-reference/workspace/listings/create"},{"title":"Duplicate listing","deprecated":null,"version":null,"sidebarTitle":"Duplicate listing","openapi":"/openapi.json post /v1/workspace/listings/{id}/duplicate","href":"/api-reference/workspace/listings/duplicate"},{"title":"Delete listing","deprecated":null,"version":null,"sidebarTitle":"Delete listing","openapi":"/openapi.json delete /v1/workspace/listings/{id}","href":"/api-reference/workspace/listings/delete"},{"group":"Images","pages":[{"title":"Add images","deprecated":null,"version":null,"sidebarTitle":"Add images","openapi":"/openapi.json post /v1/workspace/listings/{id}/images","href":"/api-reference/workspace/listings/images/add"},{"title":"Update alt text","deprecated":null,"version":null,"sidebarTitle":"Update alt text","openapi":"/openapi.json patch /v1/workspace/listings/{id}/images/{image_id}","href":"/api-reference/workspace/listings/images/update"},{"title":"Reorder images","deprecated":null,"version":null,"sidebarTitle":"Reorder images","openapi":"/openapi.json put /v1/workspace/listings/{id}/images/order","href":"/api-reference/workspace/listings/images/reorder"},{"title":"Remove image","deprecated":null,"version":null,"sidebarTitle":"Remove image","openapi":"/openapi.json delete /v1/workspace/listings/{id}/images/{image_id}","href":"/api-reference/workspace/listings/images/remove"}]},{"group":"Videos","pages":[{"title":"Add video","deprecated":null,"version":null,"sidebarTitle":"Add video","openapi":"/openapi.json post /v1/workspace/listings/{id}/videos","href":"/api-reference/workspace/listings/videos/add"},{"title":"Feature video","deprecated":null,"version":null,"sidebarTitle":"Feature video","openapi":"/openapi.json put /v1/workspace/listings/{id}/videos/featured","href":"/api-reference/workspace/listings/videos/feature"},{"title":"Remove video","deprecated":null,"version":null,"sidebarTitle":"Remove video","openapi":"/openapi.json delete /v1/workspace/listings/{id}/videos/{video_id}","href":"/api-reference/workspace/listings/videos/remove"}]},{"group":"Files","pages":[{"title":"Add file","deprecated":null,"version":null,"sidebarTitle":"Add file","openapi":"/openapi.json post /v1/workspace/listings/{id}/files","href":"/api-reference/workspace/listings/files/add"},{"title":"Remove file","deprecated":null,"version":null,"sidebarTitle":"Remove file","openapi":"/openapi.json delete /v1/workspace/listings/{id}/files/{file_id}","href":"/api-reference/workspace/listings/files/remove"}]},{"group":"Inventory","pages":[{"title":"Replace inventory","deprecated":null,"version":null,"sidebarTitle":"Replace inventory","openapi":"/openapi.json put /v1/workspace/listings/{id}/inventory","href":"/api-reference/workspace/listings/inventory/replace"},{"title":"Patch offerings","deprecated":null,"version":null,"sidebarTitle":"Patch offerings","openapi":"/openapi.json patch /v1/workspace/listings/{id}/inventory","href":"/api-reference/workspace/listings/inventory/patch"}]},{"group":"Content","pages":[{"title":"Update attributes","deprecated":null,"version":null,"sidebarTitle":"Update attributes","openapi":"/openapi.json patch /v1/workspace/listings/{id}/attributes","href":"/api-reference/workspace/listings/attributes/update"},{"title":"Set translation","deprecated":null,"version":null,"sidebarTitle":"Set translation","openapi":"/openapi.json put /v1/workspace/listings/{id}/translations/{language}","href":"/api-reference/workspace/listings/translations/update"},{"title":"Replace personalization","deprecated":null,"version":null,"sidebarTitle":"Replace personalization","openapi":"/openapi.json put /v1/workspace/listings/{id}/personalization","href":"/api-reference/workspace/listings/personalization/replace"},{"title":"Set variation images","deprecated":null,"version":null,"sidebarTitle":"Set variation images","openapi":"/openapi.json put /v1/workspace/listings/{id}/variation-images","href":"/api-reference/workspace/listings/variation_images/replace"}]}]},{"group":"Orders","pages":[{"title":"Search orders","deprecated":null,"version":null,"sidebarTitle":"Search orders","openapi":"/openapi.json get /v1/workspace/orders","href":"/api-reference/workspace/orders/search"},{"title":"Get order","deprecated":null,"version":null,"sidebarTitle":"Get order","openapi":"/openapi.json get /v1/workspace/orders/{id}","href":"/api-reference/workspace/orders/get"},{"title":"Add shipment","deprecated":null,"version":null,"sidebarTitle":"Add shipment","openapi":"/openapi.json post /v1/workspace/orders/{id}/shipments","href":"/api-reference/workspace/orders/shipments/create"}]},{"group":"Reviews","pages":[{"title":"Search reviews","deprecated":null,"version":null,"sidebarTitle":"Search reviews","openapi":"/openapi.json get /v1/workspace/reviews","href":"/api-reference/workspace/reviews/search"}]},{"group":"Customers","pages":[{"title":"Search customers","deprecated":null,"version":null,"sidebarTitle":"Search customers","openapi":"/openapi.json get /v1/workspace/customers","href":"/api-reference/workspace/customers/search"},{"title":"Get customer","deprecated":null,"version":null,"sidebarTitle":"Get customer","openapi":"/openapi.json get /v1/workspace/customers/{id}","href":"/api-reference/workspace/customers/get"}]},{"group":"Changes","pages":[{"title":"List changes","deprecated":null,"version":null,"sidebarTitle":"List changes","openapi":"/openapi.json get /v1/workspace/changes","href":"/api-reference/workspace/changes/list"},{"title":"Get change","deprecated":null,"version":null,"sidebarTitle":"Get change","openapi":"/openapi.json get /v1/workspace/changes/{id}","href":"/api-reference/workspace/changes/get"},{"title":"Revert change","deprecated":null,"version":null,"sidebarTitle":"Revert change","openapi":"/openapi.json post /v1/workspace/changes/{id}/revert","href":"/api-reference/workspace/changes/revert"}]},{"group":"Syncs","pages":[{"title":"Start sync","deprecated":null,"version":null,"sidebarTitle":"Start sync","openapi":"/openapi.json post /v1/workspace/syncs","href":"/api-reference/workspace/syncs/start"},{"title":"Get sync","deprecated":null,"version":null,"sidebarTitle":"Get sync","openapi":"/openapi.json get /v1/workspace/syncs/{id}","href":"/api-reference/workspace/syncs/get"},{"title":"List syncs","deprecated":null,"version":null,"sidebarTitle":"List syncs","openapi":"/openapi.json get /v1/workspace/syncs","href":"/api-reference/workspace/syncs/list"}]}]},{"group":"Etsy","pages":[{"group":"Catalog","pages":[{"title":"Search categories","deprecated":null,"version":null,"sidebarTitle":"Search categories","openapi":"/openapi.json get /v1/etsy/categories","href":"/api-reference/etsy/categories/search"},{"title":"Get category","deprecated":null,"version":null,"sidebarTitle":"Get category","openapi":"/openapi.json get /v1/etsy/categories/{id}","href":"/api-reference/etsy/categories/get"},{"title":"Get category properties","deprecated":null,"version":null,"sidebarTitle":"Get category properties","openapi":"/openapi.json get /v1/etsy/categories/{id}/properties","href":"/api-reference/etsy/categories/properties"},{"title":"List languages","deprecated":null,"version":null,"sidebarTitle":"List languages","openapi":"/openapi.json get /v1/etsy/languages","href":"/api-reference/etsy/languages/list"}]},{"group":"Selling","pages":[{"title":"Get listing rules","deprecated":null,"version":null,"sidebarTitle":"Get listing rules","openapi":"/openapi.json get /v1/etsy/listing-rules","href":"/api-reference/etsy/listingrules/get"},{"title":"Get fees","deprecated":null,"version":null,"sidebarTitle":"Get fees","openapi":"/openapi.json get /v1/etsy/fees","href":"/api-reference/etsy/fees/get"}]},{"group":"Countries \u0026 currencies","pages":[{"title":"List countries","deprecated":null,"version":null,"sidebarTitle":"List countries","openapi":"/openapi.json get /v1/etsy/countries","href":"/api-reference/etsy/countries/list"},{"title":"Get country","deprecated":null,"version":null,"sidebarTitle":"Get country","openapi":"/openapi.json get /v1/etsy/countries/{code}","href":"/api-reference/etsy/countries/get"},{"title":"List currencies","deprecated":null,"version":null,"sidebarTitle":"List currencies","openapi":"/openapi.json get /v1/etsy/currencies","href":"/api-reference/etsy/currencies/list"},{"title":"Get currency","deprecated":null,"version":null,"sidebarTitle":"Get currency","openapi":"/openapi.json get /v1/etsy/currencies/{code}","href":"/api-reference/etsy/currencies/get"}]},{"group":"Shipping","pages":[{"title":"Get shipping carriers","deprecated":null,"version":null,"sidebarTitle":"Get shipping carriers","openapi":"/openapi.json get /v1/etsy/shipping-carriers","href":"/api-reference/etsy/shippingcarriers/get"}]},{"group":"News \u0026 updates","pages":[{"title":"List feed","deprecated":null,"version":null,"sidebarTitle":"List feed","openapi":"/openapi.json get /v1/etsy/feed","href":"/api-reference/etsy/feed/list"},{"title":"List updates","deprecated":null,"version":null,"sidebarTitle":"List updates","openapi":"/openapi.json get /v1/etsy/updates","href":"/api-reference/etsy/updates/list"},{"title":"Get update","deprecated":null,"version":null,"sidebarTitle":"Get update","openapi":"/openapi.json get /v1/etsy/updates/{id}","href":"/api-reference/etsy/updates/get"},{"title":"List news","deprecated":null,"version":null,"sidebarTitle":"List news","openapi":"/openapi.json get /v1/etsy/news","href":"/api-reference/etsy/news/list"},{"title":"Get article","deprecated":null,"version":null,"sidebarTitle":"Get article","openapi":"/openapi.json get /v1/etsy/news/{slug}","href":"/api-reference/etsy/news/get"}]}]},{"group":"Webhooks \u0026 events","pages":[{"group":"Webhook endpoints","pages":[{"title":"Create webhook","deprecated":null,"version":null,"sidebarTitle":"Create webhook","openapi":"/openapi.json post /v1/webhooks","href":"/api-reference/webhooks/endpoints/create"},{"title":"List webhooks","deprecated":null,"version":null,"sidebarTitle":"List webhooks","openapi":"/openapi.json get /v1/webhooks","href":"/api-reference/webhooks/endpoints/list"},{"title":"Get webhook","deprecated":null,"version":null,"sidebarTitle":"Get webhook","openapi":"/openapi.json get /v1/webhooks/{id}","href":"/api-reference/webhooks/endpoints/get"},{"title":"Update webhook","deprecated":null,"version":null,"sidebarTitle":"Update webhook","openapi":"/openapi.json patch /v1/webhooks/{id}","href":"/api-reference/webhooks/endpoints/update"},{"title":"Delete webhook","deprecated":null,"version":null,"sidebarTitle":"Delete webhook","openapi":"/openapi.json delete /v1/webhooks/{id}","href":"/api-reference/webhooks/endpoints/delete"},{"title":"Send test event","description":"Send a test event to a webhook endpoint to check that it receives and verifies deliveries.","deprecated":null,"version":null,"sidebarTitle":"Send test event","openapi":"/openapi.json post /v1/webhooks/{id}/test","href":"/api-reference/webhooks/endpoints/test"},{"title":"Rotate secret","deprecated":null,"version":null,"sidebarTitle":"Rotate secret","openapi":"/openapi.json post /v1/webhooks/{id}/rotate-secret","href":"/api-reference/webhooks/endpoints/rotatesecret"}]},{"group":"Deliveries","pages":[{"title":"List deliveries","description":"List a webhook endpoint's delivery attempts from the last 30 days, with each one's HTTP status, timing and error, and the attempts still queued.","deprecated":null,"version":null,"sidebarTitle":"List deliveries","openapi":"/openapi.json get /v1/webhooks/{id}/deliveries","href":"/api-reference/webhooks/deliveries/list"}]},{"group":"Events","pages":[{"title":"List events","deprecated":null,"version":null,"sidebarTitle":"List events","openapi":"/openapi.json get /v1/events","href":"/api-reference/events/list"},{"title":"Get event","deprecated":null,"version":null,"sidebarTitle":"Get event","openapi":"/openapi.json get /v1/events/{id}","href":"/api-reference/events/get"}]}]},{"group":"Account","pages":[{"group":"Me","pages":[{"title":"Get current user","deprecated":null,"version":null,"sidebarTitle":"Get current user","openapi":"/openapi.json get /v1/me","href":"/api-reference/account/me/get"}]},{"group":"Workspaces","pages":[{"title":"List workspaces","deprecated":null,"version":null,"sidebarTitle":"List workspaces","openapi":"/openapi.json get /v1/me/workspaces","href":"/api-reference/account/workspaces/list"},{"title":"Switch workspace","deprecated":null,"version":null,"sidebarTitle":"Switch workspace","openapi":"/openapi.json post /v1/me/workspace","href":"/api-reference/account/workspace/switch"}]},{"group":"Usage","pages":[{"title":"Get usage","deprecated":null,"version":null,"sidebarTitle":"Get usage","openapi":"/openapi.json get /v1/usage","href":"/api-reference/account/usage/get"},{"title":"Get usage by day","deprecated":null,"version":null,"sidebarTitle":"Get usage by day","openapi":"/openapi.json get /v1/usage/by-day","href":"/api-reference/account/usage/byday"},{"title":"List usage events","deprecated":null,"version":null,"sidebarTitle":"List usage events","openapi":"/openapi.json get /v1/usage/events","href":"/api-reference/account/usage/events"}]}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/connect-ai"}]}]},"basePath":"","title":"Rotate secret - Alura API","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}