{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"BitGPT 402pay Documentation","colors":{"primary":"#2E74FF","light":"#F5F2E9","dark":"#1E54BF"},"logo":{"light":"https://mintcdn.com/bitgpt/N6Qn8nkrAkxXvrVZ/images/logo/light.png?fit=max\u0026auto=format\u0026n=N6Qn8nkrAkxXvrVZ\u0026q=85\u0026s=983649556b8a67d1d2025eaca748d434","dark":"https://mintcdn.com/bitgpt/N6Qn8nkrAkxXvrVZ/images/logo/dark.png?fit=max\u0026auto=format\u0026n=N6Qn8nkrAkxXvrVZ\u0026q=85\u0026s=1fb970415ae19b9b2a779415fa394d42"},"favicon":"/images/favicon.png","navbar":{"links":[{"label":"Demo","href":"https://play.bitgpt.xyz"},{"label":"Support","href":"mailto:support@bitgpt.xyz"}],"primary":{"type":"button","label":"Dashboard","href":"https://dash.bitgpt.xyz"}},"footer":{"socials":{"x":"https://x.com/BitGPTnetwork","discord":"https://bitgpt.xyz/discord"}},"seo":{"metatags":{"og:image":"/images/og.png","og:title":"BitGPT 402pay Documentation","og:description":"One platform to leverage blockchain-native payments for the future of commerce, agents and payments.","twitter:title":"BitGPT 402pay Documentation","twitter:description":"One platform to leverage blockchain-native payments for the future of commerce, agents and payments.","twitter:image":"/images/og.png"}},"styling":{"codeblocks":"system"},"contextual":{"options":["chatgpt","claude","copy","view"]},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"bitgpt","hasAudioNarration":false,"actualSubdomain":"bitgpt","customDomains":["docs.bitgpt.xyz"],"gitSource":{"type":"github","owner":"bit-gpt","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e6c694a5dc2e6daf4379","collectionId":"c41e2263-12b1-4185-9c84-da13bd9e6d07","schemaVersion":"v2"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6a21e6c694a5dc2e6daf4379:success","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"Developer resources","count":71},{"language":"default","tag":"API REFERENCE","count":45},{"language":"default","tag":"WEBHOOKS","count":16},{"language":"default","tag":"Payloads","count":14},{"language":"default","tag":"Payments and Invoices","count":12},{"language":"default","tag":"Webhooks","count":12},{"language":"default","tag":"Get started","count":11},{"language":"default","tag":"GET STARTED","count":10},{"language":"default","tag":"API Keys","count":10},{"language":"default","tag":"Schemas","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"developer-resources/schemas/webhook","slug":"/developer-resources/schemas/webhook","pageMetadata":{"title":"Webhook","sidebarTitle":"Webhook","icon":"brackets-curly","openapi":"/developer-resources/reference/openapi.json","openapi-schema":"developersWebhook","description":null,"href":"/developer-resources/schemas/webhook"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Webhook","sidebarTitle":"Webhook","icon":"brackets-curly","openapi":"/developer-resources/reference/openapi.json","openapi-schema":"developersWebhook","description":null,"href":"/developer-resources/schemas/webhook"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"schemaData":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the webhook","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"label":{"type":"string","description":"Human-readable label for the webhook","maxLength":255,"isRequired":true,"uniqueKey":"label","typeLabel":"string"},"url":{"type":"string","format":"uri","description":"URL where webhook events will be sent","isRequired":true,"uniqueKey":"url","typeLabel":"string\u003curi>"},"events":{"type":"array","description":"List of events this webhook subscribes to","items":{"oneOf":[{"type":"string","description":"Webhook event for when an API key is created","enum":["api_key.created"],"example":"product.created","uniqueKey":"events.items.[INDEX].oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Webhook event for when an API key is updated","enum":["api_key.updated"],"example":"product.created","uniqueKey":"events.items.[INDEX].oneOf.1","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Webhook event for when an API key is deleted","enum":["api_key.deleted"],"example":"product.created","uniqueKey":"events.items.[INDEX].oneOf.2","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Webhook event for when a product is created","enum":["product.created"],"example":"product.created","uniqueKey":"events.items.[INDEX].oneOf.3","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Webhook event for when a product is updated","enum":["product.updated"],"example":"product.created","uniqueKey":"events.items.[INDEX].oneOf.4","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Webhook event for when a product is deleted","enum":["product.deleted"],"example":"product.created","uniqueKey":"events.items.[INDEX].oneOf.5","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Webhook event for when an invoice is created","enum":["invoice.created"],"example":"product.created","uniqueKey":"events.items.[INDEX].oneOf.6","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Webhook event for when an invoice is updated","enum":["invoice.updated"],"example":"product.created","uniqueKey":"events.items.[INDEX].oneOf.7","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Webhook event for when an invoice is completed","enum":["invoice.completed"],"example":"product.created","uniqueKey":"events.items.[INDEX].oneOf.8","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Webhook event for when an invoice is canceled","enum":["invoice.cancelled"],"example":"product.created","uniqueKey":"events.items.[INDEX].oneOf.9","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Webhook event for when a payment is created","enum":["payment.created"],"example":"product.created","uniqueKey":"events.items.[INDEX].oneOf.10","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Webhook event for when a payment is updated","enum":["payment.updated"],"example":"product.created","uniqueKey":"events.items.[INDEX].oneOf.11","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Webhook event for when a payment is completed","enum":["payment.completed"],"example":"product.created","uniqueKey":"events.items.[INDEX].oneOf.12","typeLabel":"enum\u003cstring>"},{"type":"string","description":"Webhook event for when a payment is cancelled","enum":["payment.cancelled"],"example":"product.created","uniqueKey":"events.items.[INDEX].oneOf.13","typeLabel":"enum\u003cstring>"}],"uniqueKey":"events.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"events","typeLabel":"enum\u003cstring>[]"},"description":{"oneOf":[{"type":"string","description":"Description for the webhook","isRequired":true,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Description for the webhook","isRequired":true,"uniqueKey":"description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"description","typeLabel":"string | null"},"created_at":{"type":"string","format":"mysql-date-time","examples":["2025-06-29 16:03:44"],"description":"Timestamp when the webhook was created","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cmysql-date-time>"},"updated_at":{"oneOf":[{"type":"string","description":"Timestamp when the webhook was last updated","format":"mysql-date-time","example":"2025-06-29 16:03:44","isRequired":true,"uniqueKey":"updated_at.oneOf.0","typeLabel":"string\u003cmysql-date-time>"},{"type":"null","description":"Timestamp when the webhook was last updated","format":"mysql-date-time","example":"2025-06-29 16:03:44","isRequired":true,"uniqueKey":"updated_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cmysql-date-time> | null"},"secret":{"type":"string","description":"Secret used to sign webhook payloads","uniqueKey":"secret","typeLabel":"string"},"enabled":{"type":"number","description":"Indicates if the webhook is currently enabled","default":1,"uniqueKey":"enabled","typeLabel":"number"},"day_metrics":{"oneOf":[{"type":"object","properties":{"webhook_id":{"type":"string","description":"Unique identifier for the webhook","uniqueKey":"day_metrics.oneOf.0.webhook_id","typeLabel":"string"},"total":{"type":"integer","description":"Total number of webhook deliveries","uniqueKey":"day_metrics.oneOf.0.total","typeLabel":"integer"},"success":{"type":"integer","description":"Number of successful webhook deliveries","uniqueKey":"day_metrics.oneOf.0.success","typeLabel":"integer"},"failed":{"type":"integer","description":"Number of failed webhook deliveries","uniqueKey":"day_metrics.oneOf.0.failed","typeLabel":"integer"},"pending":{"type":"integer","description":"Number of pending webhook deliveries","uniqueKey":"day_metrics.oneOf.0.pending","typeLabel":"integer"},"retry_rate_pct":{"type":"number","description":"Average number of retries per webhook delivery","uniqueKey":"day_metrics.oneOf.0.retry_rate_pct","typeLabel":"number"},"avg_delay_ms":{"type":"number","description":"Average delay in seconds for webhook deliveries","uniqueKey":"day_metrics.oneOf.0.avg_delay_ms","typeLabel":"number"}},"uniqueKey":"day_metrics.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"day_metrics.oneOf.1","typeLabel":"null"}],"uniqueKey":"day_metrics","typeLabel":"object | null"},"hourly_metrics":{"oneOf":[{"type":"array","items":{"type":"object","description":"Hourly metrics","properties":{"hour":{"type":"string","description":"Hour in format YYYY-MM-DD HH:00:00","isRequired":true,"uniqueKey":"hourly_metrics.oneOf.0.items.[INDEX].hour","typeLabel":"string"},"total":{"type":"integer","description":"Total number of webhook deliveries in this hour","isRequired":true,"uniqueKey":"hourly_metrics.oneOf.0.items.[INDEX].total","typeLabel":"integer"},"success":{"type":"integer","description":"Number of successful webhook deliveries in this hour","isRequired":true,"uniqueKey":"hourly_metrics.oneOf.0.items.[INDEX].success","typeLabel":"integer"},"failed":{"type":"integer","description":"Number of failed webhook deliveries in this hour","isRequired":true,"uniqueKey":"hourly_metrics.oneOf.0.items.[INDEX].failed","typeLabel":"integer"},"pending":{"type":"integer","description":"Number of pending webhook deliveries in this hour","isRequired":true,"uniqueKey":"hourly_metrics.oneOf.0.items.[INDEX].pending","typeLabel":"integer"},"webhook_id":{"type":"string","description":"ID of the webhook for which metrics are being reported","uniqueKey":"hourly_metrics.oneOf.0.items.[INDEX].webhook_id","typeLabel":"string"}},"required":["hour","total","success","failed","pending"],"uniqueKey":"hourly_metrics.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Hourly metrics for the last 24 hours","uniqueKey":"hourly_metrics.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Hourly metrics for the last 24 hours","uniqueKey":"hourly_metrics.oneOf.1","typeLabel":"null"}],"uniqueKey":"hourly_metrics","typeLabel":"object[] | null"}},"required":["id","label","url","events","description","created_at","updated_at"],"uniqueKey":"","typeLabel":"object","example":{"title":"Example","value":{"id":"\u003cstring>","label":"\u003cstring>","url":"\u003cstring>","events":["product.created"],"description":"\u003cstring>","created_at":"2025-06-29 16:03:44","updated_at":"2025-06-29 16:03:44","secret":"\u003cstring>","enabled":1,"day_metrics":{"webhook_id":"\u003cstring>","total":123,"success":123,"failed":123,"pending":123,"retry_rate_pct":123,"avg_delay_ms":123},"hourly_metrics":[{"hour":"\u003cstring>","total":123,"success":123,"failed":123,"pending":123,"webhook_id":"\u003cstring>"}]}}},"originalFileLocation":"developer-resources/reference/openapi.json"},"subdomain":"bitgpt","siteName":"BitGPT 402pay Documentation","title":"BitGPT 402pay Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-08-30T15:06:36.184Z","originalFileLocation":"developer-resources/schemas/webhook.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"BitGPT 402pay Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/bitgpt/TXnqDz_1-WZcwU5O/_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/bitgpt/TXnqDz_1-WZcwU5O/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/bitgpt/TXnqDz_1-WZcwU5O/_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/bitgpt/TXnqDz_1-WZcwU5O/_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/bitgpt/TXnqDz_1-WZcwU5O/_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/bitgpt/TXnqDz_1-WZcwU5O/_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/bitgpt/TXnqDz_1-WZcwU5O/_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/bitgpt/TXnqDz_1-WZcwU5O/_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/bitgpt/TXnqDz_1-WZcwU5O/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"BitGPT 402pay Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"One platform to leverage blockchain-native payments for the future of commerce, agents and payments.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"BitGPT 402pay Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.bitgpt.xyz/developer-resources/schemas/webhook\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://bitgpt.mintlify.app/images/og.png\">\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=\"BitGPT 402pay Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"One platform to leverage blockchain-native payments for the future of commerce, agents and payments.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bitgpt.mintlify.app/images/og.png\">\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/bitgpt/TXnqDz_1-WZcwU5O/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"BitGPT 402pay Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2E74FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.bitgpt.xyz/developer-resources/schemas/webhook\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/developer-resources/schemas/webhook.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.bitgpt.xyz/#organization\",\"name\":\"BitGPT 402pay Documentation\",\"url\":\"https://docs.bitgpt.xyz\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/bitgpt/N6Qn8nkrAkxXvrVZ/images/logo/light.png?fit=max\u0026auto=format\u0026n=N6Qn8nkrAkxXvrVZ\u0026q=85\u0026s=983649556b8a67d1d2025eaca748d434\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.bitgpt.xyz#website\",\"name\":\"BitGPT 402pay Documentation\",\"url\":\"https://docs.bitgpt.xyz\",\"publisher\":{\"@id\":\"https://docs.bitgpt.xyz/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.bitgpt.xyz/developer-resources/schemas/webhook#webpage\",\"url\":\"https://docs.bitgpt.xyz/developer-resources/schemas/webhook\",\"name\":\"Webhook\",\"dateModified\":\"2025-08-30T15:06:36.184Z\",\"isPartOf\":{\"@id\":\"https://docs.bitgpt.xyz#website\"},\"breadcrumb\":{\"@id\":\"https://docs.bitgpt.xyz/developer-resources/schemas/webhook#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.bitgpt.xyz/developer-resources/schemas/webhook#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API REFERENCE\",\"item\":\"https://docs.bitgpt.xyz/developer-resources/schemas/response-200\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Schemas\",\"item\":\"https://docs.bitgpt.xyz/developer-resources/schemas/response-200\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Webhook\",\"item\":\"https://docs.bitgpt.xyz/developer-resources/schemas/webhook\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.bitgpt.xyz/developer-resources/schemas/webhook#apireference\",\"headline\":\"Webhook\",\"name\":\"Webhook\",\"url\":\"https://docs.bitgpt.xyz/developer-resources/schemas/webhook\",\"mainEntityOfPage\":{\"@id\":\"https://docs.bitgpt.xyz/developer-resources/schemas/webhook#webpage\"},\"image\":\"https://docs.bitgpt.xyz/images/og.png\",\"dateModified\":\"2025-08-30T15:06:36.184Z\",\"publisher\":{\"@id\":\"https://docs.bitgpt.xyz/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.bitgpt.xyz#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"BitGPT 402pay Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"BitGPT 402pay Documentation","nav":{"global":null,"tabs":[{"tab":"Get started","pages":[{"title":"Get started","href":"/basics/get-started/bitgpt"}]},{"tab":"Infrastructure","pages":[{"title":"Infrastructure","href":"/infrastructure/architecture"}]},{"tab":"Developer resources","groups":[{"group":"GET STARTED","pages":[{"title":"Introduction","sidebarTitle":"Introduction","icon":"arrow-right-to-arc","href":"/developer-resources/get-started/introduction"},{"title":"API Keys","sidebarTitle":"API Keys","icon":"key","href":"/developer-resources/get-started/api-keys"},{"title":"Authentication","sidebarTitle":"Authentication","icon":"lock","href":"/developer-resources/get-started/authentication"},{"title":"Sandbox","sidebarTitle":"Sandbox","icon":"flask-vial","href":"/developer-resources/get-started/sandbox"},{"title":"Errors","sidebarTitle":"Errors","icon":"bomb","href":"/developer-resources/get-started/errors"},{"title":"Rate limits","sidebarTitle":"Rate limits","icon":"wave-pulse","href":"/developer-resources/get-started/rate-limits"},{"title":"Idempotency","sidebarTitle":"Idempotency","icon":"fingerprint","href":"/developer-resources/get-started/idempotency"},{"title":"Expanding Objects","sidebarTitle":"Expanding Objects","icon":"expand","href":"/developer-resources/get-started/expanding-objects"},{"title":"Providers and Gateways","sidebarTitle":"Providers and Gateways","icon":"receipt","href":"/developer-resources/get-started/providers-gateways"},{"title":"Metadata","sidebarTitle":"Metadata","icon":"database","href":"/developer-resources/get-started/metadata"}]},{"group":"WEBHOOKS","pages":[{"title":"Webhooks","sidebarTitle":"Overview","icon":"webhook","href":"/developer-resources/webhooks/overview"},{"title":"Events","sidebarTitle":"Events","icon":"list-tree","href":"/developer-resources/webhooks/events"},{"group":"Payloads","icon":"brackets-curly","pages":[{"group":"Invoices","icon":"receipt","pages":[{"title":"invoice.created","openapi":"developer-resources/reference/openapi.json webhook invoice.created","href":"/developer-resources/webhooks/events/invoices/invoice-created"},{"title":"invoice.updated","openapi":"developer-resources/reference/openapi.json webhook invoice.updated","href":"/developer-resources/webhooks/events/invoices/invoice-updated"},{"title":"invoice.completed","openapi":"developer-resources/reference/openapi.json webhook invoice.completed","href":"/developer-resources/webhooks/events/invoices/invoice-completed"},{"title":"invoice.cancelled","openapi":"developer-resources/reference/openapi.json webhook invoice.cancelled","href":"/developer-resources/webhooks/events/invoices/invoice-cancelled"}]},{"group":"Payments","icon":"credit-card","pages":[{"title":"payment.created","openapi":"developer-resources/reference/openapi.json webhook payment.created","href":"/developer-resources/webhooks/events/payments/payment-created"},{"title":"payment.updated","openapi":"developer-resources/reference/openapi.json webhook payment.updated","href":"/developer-resources/webhooks/events/payments/payment-updated"},{"title":"payment.completed","openapi":"developer-resources/reference/openapi.json webhook payment.completed","href":"/developer-resources/webhooks/events/payments/payment-completed"},{"title":"payment.cancelled","openapi":"developer-resources/reference/openapi.json webhook payment.cancelled","href":"/developer-resources/webhooks/events/payments/payment-cancelled"}]},{"group":"Products","icon":"conveyor-belt-arm","pages":[{"title":"product.created","openapi":"developer-resources/reference/openapi.json webhook product.created","href":"/developer-resources/webhooks/events/products/product-created"},{"title":"product.updated","openapi":"developer-resources/reference/openapi.json webhook product.updated","href":"/developer-resources/webhooks/events/products/product-updated"},{"title":"product.deleted","openapi":"developer-resources/reference/openapi.json webhook product.deleted","href":"/developer-resources/webhooks/events/products/product-deleted"}]},{"group":"API Keys","icon":"key","pages":[{"title":"api_key.created","openapi":"developer-resources/reference/openapi.json webhook api_key.created","href":"/developer-resources/webhooks/events/api_keys/api_key-created"},{"title":"api_key.updated","openapi":"developer-resources/reference/openapi.json webhook api_key.updated","href":"/developer-resources/webhooks/events/api_keys/api_key-updated"},{"title":"api_key.deleted","openapi":"developer-resources/reference/openapi.json webhook api_key.deleted","href":"/developer-resources/webhooks/events/api_keys/api_key-deleted"}]}]}]},{"group":"API REFERENCE","pages":[{"group":"Schemas","icon":"brackets-curly","pages":[{"title":"2xx Response","sidebarTitle":"2xx Response","icon":"brackets-curly","openapi":"/developer-resources/reference/openapi.json","href":"/developer-resources/schemas/response-200"},{"title":"Currency","sidebarTitle":"Currency","icon":"brackets-curly","openapi":"/developer-resources/reference/openapi.json","href":"/developer-resources/schemas/currency"},{"title":"Provider","sidebarTitle":"Provider","icon":"brackets-curly","openapi":"/developer-resources/reference/openapi.json","href":"/developer-resources/schemas/provider"},{"title":"Invoice","sidebarTitle":"Invoice","icon":"brackets-curly","openapi":"/developer-resources/reference/openapi.json","href":"/developer-resources/schemas/invoice"},{"title":"File","sidebarTitle":"File","icon":"brackets-curly","openapi":"/developer-resources/reference/openapi.json","href":"/developer-resources/schemas/file"},{"title":"Product","sidebarTitle":"Product","icon":"brackets-curly","openapi":"/developer-resources/reference/openapi.json","href":"/developer-resources/schemas/product"},{"title":"API Key","sidebarTitle":"API Key","icon":"brackets-curly","openapi":"/developer-resources/reference/openapi.json","description":null,"href":"/developer-resources/schemas/api-key"},{"title":"Webhook","sidebarTitle":"Webhook","icon":"brackets-curly","openapi":"/developer-resources/reference/openapi.json","href":"/developer-resources/schemas/webhook"}]},{"group":"API Keys","icon":"key","pages":[{"openapi":"post /developers/api_keys","title":"Create a new API key","description":"Create a new API key for the organization","href":"/developer-resources/reference/api-keys/create-api-key"},{"openapi":"get /developers/api_keys/{id}","title":"Get an API key","href":"/developer-resources/reference/api-keys/get-api-key"},{"openapi":"put /developers/api_keys/{id}","title":"Update an API key","href":"/developer-resources/reference/api-keys/update-api-key"},{"openapi":"delete /developers/api_keys/{id}","title":"Delete an API key","href":"/developer-resources/reference/api-keys/delete-api-key"},{"openapi":"get /analytics/api_keys","title":"Get API key analytics","href":"/developer-resources/reference/api-keys/get-api-key-analytics"},{"openapi":"get /developers/api_keys/scopes","title":"List API key scopes","href":"/developer-resources/reference/api-keys/list-api-key-scopes"},{"openapi":"get /developers/api_keys","title":"List API keys","href":"/developer-resources/reference/api-keys/list-api-keys"}]},{"group":"Files","icon":"file","pages":[{"openapi":"post /files/upload","title":"Upload a file","href":"/developer-resources/reference/files/upload-a-file"},{"openapi":"get /files/{id}","title":"Get file details","href":"/developer-resources/reference/files/get-file-details"},{"openapi":"get /files","title":"List files","href":"/developer-resources/reference/files/list-files"},{"openapi":"delete /files/{id}","title":"Delete file","href":"/developer-resources/reference/files/delete-file"}]},{"group":"Payments and Invoices","icon":"receipt","pages":[{"openapi":"post /analytics/dashboard","title":"Get dashboard analytics","href":"/developer-resources/reference/payments/analytics"},{"openapi":"post /invoices/create","title":"Create an invoice","href":"/developer-resources/reference/payments/create-an-invoice"},{"openapi":"put /invoices/{id}","title":"Update invoice","href":"/developer-resources/reference/payments/update-an-invoice"},{"openapi":"post /invoices/{id}","title":"Get invoice details","href":"/developer-resources/reference/payments/get-invoice-details"},{"openapi":"get /invoices/{id}/short_state","title":"Get invoice short state","href":"/developer-resources/reference/payments/get-invoice-short-state"},{"openapi":"get /providers/{invoice_id}","title":"Get invoice providers","href":"/developer-resources/reference/payments/get-invoice-providers"},{"openapi":"post /invoices/list","title":"List invoices","href":"/developer-resources/reference/payments/list-invoices"},{"openapi":"post /payments","title":"List payments","href":"/developer-resources/reference/payments/list-payments"},{"openapi":"post /payments/{id}","title":"Get payment details","href":"/developer-resources/reference/payments/get-payment-details"},{"openapi":"put /payments/{id}","title":"Update payment","href":"/developer-resources/reference/payments/update-a-payment"},{"openapi":"post /pay/quote","title":"Quote payment","href":"/developer-resources/reference/payments/quote-payment"},{"openapi":"post /invoices/validate","title":"Validate invoice data","href":"/developer-resources/reference/payments/validate-invoice-data"}]},{"group":"Products","icon":"conveyor-belt-arm","pages":[{"openapi":"post /products","title":"Create a new product","href":"/developer-resources/reference/products/create-a-new-product"},{"openapi":"get /products/{id}","title":"Get a product","href":"/developer-resources/reference/products/get-a-product"},{"openapi":"get /products","title":"List products","href":"/developer-resources/reference/products/list-products"},{"openapi":"put /products/{id}","title":"Update a product","href":"/developer-resources/reference/products/update-a-product"}]},{"group":"Webhooks","icon":"webhook","pages":[{"openapi":"post /developers/webhooks","title":"Create a new webhook","href":"/developer-resources/reference/webhooks/create-a-new-webhook"},{"openapi":"get /developers/webhooks/{id}","title":"Get a webhook","href":"/developer-resources/reference/webhooks/get-a-webhook"},{"openapi":"get /analytics/webhooks","title":"Get webhook analytics","href":"/developer-resources/reference/webhooks/get-webhook-analytics"},{"openapi":"get /analytics/webhooks/{id}","title":"Get webhook analytics by ID","href":"/developer-resources/reference/webhooks/get-webhook-analytics-by-id"},{"openapi":"get /developers/webhooks/events","title":"Get webhook events","href":"/developer-resources/reference/webhooks/get-webhook-events"},{"openapi":"get /developers/webhooks","title":"List webhooks","href":"/developer-resources/reference/webhooks/list-webhooks"},{"openapi":"get /developers/webhooks/queue","title":null,"href":"/developer-resources/reference/webhooks/list-webhook-queue-items"},{"openapi":"post /developers/webhooks/queue/{id}/retry","title":"Retry a webhook queue item","href":"/developer-resources/reference/webhooks/retry-a-webhook-queue-item"},{"openapi":"put /developers/webhooks/{id}","title":"Update a webhook","href":"/developer-resources/reference/webhooks/update-a-webhook"},{"openapi":"delete /developers/webhooks/{id}","title":"Delete a webhook","href":"/developer-resources/reference/webhooks/delete-a-webhook"}]}]}]},{"tab":"Recipes","pages":[{"title":"Recipes","href":"/recipes/overview"}]},{"tab":"HTTP 402","pages":[{"title":"HTTP 402","href":"/h402/introduction"}]}]},"basePath":"","title":"BitGPT 402pay Documentation","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}