{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Avalanche APIs \u0026 SDKs Documentation","colors":{"primary":"#FF394A","light":"#FF6673","dark":"#FF394A"},"logo":{"light":"https://mintcdn.com/avalabs-47ea3976/aMFVWopw05lo-Yr3/logo/logo-light.svg?fit=max\u0026auto=format\u0026n=aMFVWopw05lo-Yr3\u0026q=85\u0026s=58b1edd9671d525af4dad6fa86626763","dark":"https://mintcdn.com/avalabs-47ea3976/aMFVWopw05lo-Yr3/logo/logo-dark.svg?fit=max\u0026auto=format\u0026n=aMFVWopw05lo-Yr3\u0026q=85\u0026s=8fbf7146fe796f7ec0457a6f800151e2"},"favicon":"/favicon.png","api":{"playground":{"proxy":false}},"background":{"color":{"light":"#FFFFFF","dark":"#000000"}},"navbar":{"links":[{"label":"Academy","href":"https://academy.avax.network/"},{"label":"Support","href":"https://discord.gg/avax"}],"primary":{"type":"button","label":"Get API Keys","href":"https://build.avax.network/console/utilities/data-api-keys"}},"footer":{"socials":{"x":"https://x.com/AvaxDevelopers","github":"https://github.com/ava-labs","youtube":"https://www.youtube.com/@Avalancheavax","discord":"https://discord.gg/avax","medium":"https://medium.com/@avaxdevelopers"}},"seo":{"metatags":{"og:image":"https://github.com/javiertc/image/blob/main/og-avalanche-api-documentation.png?raw=True","og:description":"Accelerate your development across 100+ Layer 1 blockchains with powerful SDKs, APIs, guides, and tutorials.","og:site_name":"Avalanche API Documentation","og:site_logo":"https://cdn.prod.website-files.com/632993e1d1acbfa5635afd0b/66e44b097229055c691e7555_AvalancheLogo_Horizontal_4C_White.svg","twitter:site":"@AvaxDevelopers","twitter:card":"summary_large_image","twitter:title":"Avalanche API Documentation","twitter:description":"Accelerate your development across 100+ Layer 1 blockchains with powerful SDKs, APIs, guides, and tutorials.","twitter:image":"https://github.com/javiertc/image/blob/main/og-avalanche-api-documentation.png?raw=True","twitter:image:alt":"Avalanche API Documentation"},"indexing":"navigable"},"contextual":{"options":["copy","view","chatgpt","claude"]},"navigation":{"global":{"anchors":[{"anchor":"Builder Hub","icon":"laptop-code","href":"https://build.avax.network/"},{"anchor":"Academy","icon":"book-open-cover","href":"https://academy.avax.network/"},{"anchor":"Community","icon":"discord","href":"https://discord.gg/avax"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"avalabs-47ea3976","hasAudioNarration":false,"actualSubdomain":"avalabs-47ea3976","customDomains":["developers.avacloud.io"],"gitSource":{"type":"github","owner":"ava-labs","repo":"avacloud-dev-doc","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21f61352911a466b87d2b6","collectionId":"c7df53f0-2d8a-43a6-82bc-817ca99ed761","schemaVersion":"v2"},"feedback":{"thumbs":true,"edits":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"DISABLED"},"CONTEXTUAL_FEEDBACK":{"status":"DISABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6a21f61352911a466b87d2b6:success","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Data API","count":81},{"language":"default","tag":"RPC API","count":34},{"language":"default","tag":"EVM","count":33},{"language":"default","tag":"Platform Chain (P-Chain)","count":30},{"language":"default","tag":"Primary Network","count":25},{"language":"default","tag":"Webhooks API","count":24},{"language":"default","tag":"Get Started","count":23},{"language":"default","tag":"Transactions","count":20},{"language":"default","tag":"Metrics API","count":14},{"language":"default","tag":"Avalanche SDK","count":11}]},"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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@keyframes dropdownFadeIn{0%{opacity:0;transform:translateY(-5px)}to{opacity:1;transform:translateY(0)}}:root{--primary-color:#ff3649;--primary-hover:#ff394a;--text-gray:#333;--text-gray-light:#7979797a;--bg-hover-light:#f5f5f5;--bg-hover-dark:#2a2a2a;--bg-dark:#1a1a1a;--border-dark:#333;--spacing-xs:4px;--spacing-sm:8px;--spacing-md:10px;--spacing-lg:20px;--spacing-xl:40px;--font-weight-normal:500;--font-weight-bold:600;--transition-fast:0.2s ease;--transition-normal:0.3s ease}.text-5xl{font-size:3rem;line-height:1}.text-4xl{font-size:2.25rem;line-height:2.5rem}.text-3xl{font-size:1.875rem;line-height:2.25rem}.text-2xl,.text-xl{font-size:1.5rem;line-height:2rem}.text-lg p{font-size:1.025rem}.search-buttons{display:flex;flex-wrap:wrap;justify-content:center;gap:var(--spacing-md)}.search-buttons a{text-decoration:none;padding:var(--spacing-md) var(--spacing-lg);border-radius:30px;display:inline-block;font-size:16px;border:1px solid var(--text-gray-light);font-weight:var(--font-weight-normal);transition:background-color var(--transition-normal),color var(--transition-normal),border var(--transition-normal)}.search-buttons a:hover{background-color:var(--primary-color);color:#fff;border-color:var(--primary-color)}.footer{min-height:10rem;overflow:hidden;margin-top:var(--spacing-xl)}.footer-container{width:1376px;max-width:100%;display:flex;justify-content:space-between}.custom-item{flex:1}.custom-item img{pointer-events:none;user-select:none;cursor:default}.logo{margin-bottom:var(--spacing-md);margin-left:var(--spacing-lg)}.item-1{height:50px;display:flex;justify-content:flex-start;align-items:center;margin-left:-20px}.item-2{min-width:211px}.item-3{width:fit-content}.item-justify-end{display:flex;justify-content:flex-end}.navbar-dropdown{position:relative;display:inline-block}.navbar-dropdown::before{content:'';position:absolute;top:100%;left:-10px;right:-10px;height:20px;z-index:999}.navbar-dropdown-content{display:none;position:absolute;background-color:#fff;min-width:280px;box-shadow:0 8px 16px 0 rgba(0,0,0,.2);z-index:1000;border-radius:8px;padding:var(--spacing-sm) 0;margin-top:var(--spacing-xs);left:0;animation:dropdownFadeIn .2s ease-out;pointer-events:auto}.dark .navbar-dropdown-content{background-color:var(--bg-dark);border:1px solid var(--border-dark)}.navbar-dropdown-content a{color:var(--text-gray);padding:14px var(--spacing-lg);text-decoration:none;display:flex;align-items:center;gap:var(--spacing-md);font-size:14px;transition:background-color var(--transition-fast);width:100%;box-sizing:border-box}.dark .navbar-dropdown-content a{color:#fff}.navbar-dropdown-content a:hover{background-color:var(--bg-hover-light)}.dark .navbar-dropdown-content a:hover{background-color:var(--bg-hover-dark)}.navbar-dropdown-content a i.lucide,.navbar-dropdown-content a svg{width:16px;height:16px;flex-shrink:0}.navbar-dropdown-content a i.lucide{display:inline-flex;align-items:center;justify-content:center}.navbar-dropdown>a{display:flex;align-items:center;gap:var(--spacing-xs);cursor:pointer;user-select:none}.navbar-dropdown>a::after{content:'';display:inline-block;width:0;height:0;margin-left:var(--spacing-xs);vertical-align:middle;border-top:4px solid;border-right:4px solid transparent;border-bottom:0;border-left:4px solid transparent;transition:transform .2s ease}.navbar-dropdown.open>a::after{transform:rotate(180deg)}@media (max-width:800px){.footer-container{width:100%;padding:0 20px}.custom-item{min-width:300px}.item-1,.item-2{order:1;justify-content:center}.item-2{order:3;margin-top:50px}.item-3{order:2}.item-3,.item-justify-end{justify-content:center}}"}],"page":{"pagePath":"webhooks-api/webhooks/create-a-webhook","slug":"/webhooks-api/webhooks/create-a-webhook","pageMetadata":{"openapi":"post /v1/webhooks","title":"Create a webhook","description":"Create a new webhook.","href":"/webhooks-api/webhooks/create-a-webhook"},"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: \"Create a new webhook.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /v1/webhooks","title":"Create a webhook","description":"Create a new webhook.","href":"/webhooks-api/webhooks/create-a-webhook"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/avalabs-47ea3976/c3ff25aa46861ed7/replace_lang_label.js","/_mintlify/custom/avalabs-47ea3976/532b775fb039c6cf/custom.js"],"openApiReferenceData":{"operation":{"operationId":"createWebhook","x-speakeasy-group":"webhooks","x-speakeasy-name-override":"create","x-execution-weight":"medium","summary":"Create a webhook","description":"Create a new webhook.","requestBody":"a7add26e-bfa9-4278-a3ac-129ac932a0ac","responses":{"201":"f8e7b5bc-93b2-4057-8bc6-9ae6b8107c27","400":"4bf83409-f3d6-4d3b-9049-0cd92f5d9b89","401":"190f279e-1119-4d1a-b055-ac2605a44d1e","403":"cf6342c3-0b6a-4777-85b4-299dc187b107","404":"8042517f-3480-466d-86f7-0369f8893121","429":"933f0573-dcb5-4554-a45d-da73f93dbc13","500":"a9700821-1a1d-45d2-863e-bffddba29c6a","502":"549ed303-2d0b-41d8-89a7-94695e02af85","503":"68026543-ee83-47a1-a10c-016f7b3b7e0c"},"tags":["Webhooks"],"x-codeSamples":[{"lang":"javascript","label":"JavaScript","source":"import { Avalanche } from \"@avalanche-sdk/chainkit\";\n\nconst avalanche = new Avalanche();\n\nasync function run() {\n const result = await avalanche.webhooks.create({\n eventType: \"address_activity\",\n url: \"https://sophisticated-exterior.org/\",\n chainId: \"\u003cid>\",\n metadata: {\n eventSignatures: [\n \"0x61cbb2a3dee0b6064c2e681aadd61677fb4ef319f0b547508d495626f5a62f64\",\n ],\n addresses: [\n \"0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E\",\n ],\n },\n });\n\n console.log(result);\n}\n\nrun();"}],"method":"post","type":"path","servers":["537ad5f1-0b28-45d3-812a-1093461f71e4"],"security":["573c8757-ee68-44b4-8976-3d873544a796","6ae389f9-883b-412b-a21f-b427663640ab"],"path":"/v1/webhooks","baseUrlOptions":["https://glacier-api.avax.network"],"title":"Create a webhook","codeSamples":[{"label":"JavaScript","lang":"javascript","source":"import { Avalanche } from \"@avalanche-sdk/chainkit\";\n\nconst avalanche = new Avalanche();\n\nasync function run() {\n const result = await avalanche.webhooks.create({\n eventType: \"address_activity\",\n url: \"https://sophisticated-exterior.org/\",\n chainId: \"\u003cid>\",\n metadata: {\n eventSignatures: [\n \"0x61cbb2a3dee0b6064c2e681aadd61677fb4ef319f0b547508d495626f5a62f64\",\n ],\n addresses: [\n \"0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E\",\n ],\n },\n });\n\n console.log(result);\n}\n\nrun();"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["eventType","url","chainId","metadata"],"properties":{"eventType":{"type":"string","enum":["address_activity"],"isRequired":true,"uniqueKey":"oneOf.0.eventType","typeLabel":"enum\u003cstring>"},"url":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.url","typeLabel":"string"},"chainId":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.chainId","typeLabel":"string"},"metadata":{"type":"object","required":["addresses"],"properties":{"addresses":{"description":"Ethereum address(es) for the address_activity event type. The maximum number of 'addresses' you can track depends on the Data API plan you are subscribed to.","examples":[["0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E"]],"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.metadata.addresses.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"oneOf.0.metadata.addresses","typeLabel":"string[]"},"eventSignatures":{"description":"Array of hexadecimal strings of the event signatures.","examples":[["0x61cbb2a3dee0b6064c2e681aadd61677fb4ef319f0b547508d495626f5a62f64"]],"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.metadata.eventSignatures.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.0.metadata.eventSignatures","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"oneOf.0.metadata","typeLabel":"object"},"name":{"type":"string","uniqueKey":"oneOf.0.name","typeLabel":"string"},"description":{"type":"string","uniqueKey":"oneOf.0.description","typeLabel":"string"},"includeInternalTxs":{"type":"boolean","description":"Whether to include traces in the webhook payload. Traces are only available for C-Chain on chainId 43113 and 43114.","uniqueKey":"oneOf.0.includeInternalTxs","typeLabel":"boolean"},"includeLogs":{"type":"boolean","description":"Whether to include logs in the webhook payload.","uniqueKey":"oneOf.0.includeLogs","typeLabel":"boolean"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["eventType","url","network","chainId","metadata"],"properties":{"eventType":{"type":"string","enum":["primary_network_address_activity"],"isRequired":true,"uniqueKey":"oneOf.1.eventType","typeLabel":"enum\u003cstring>"},"url":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.url","typeLabel":"string"},"network":{"type":"string","enum":["mainnet","fuji"],"isRequired":true,"uniqueKey":"oneOf.1.network","typeLabel":"enum\u003cstring>"},"chainId":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.chainId","typeLabel":"string"},"metadata":{"type":"object","description":"Metadata for platform address activity event","required":["keyType","keys","subEvents"],"properties":{"keyType":{"type":"string","description":"The type of key to monitor for the address activity event type.","enum":["addresses"],"isRequired":true,"uniqueKey":"oneOf.1.metadata.keyType","typeLabel":"enum\u003cstring>"},"keys":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.metadata.keys.items.[INDEX]","typeLabel":"string"},"description":"Array of keys like addresses corresponding to the keyType being monitored. For PrimaryNetworkAddressActivity event, an array of multiple addresses can be provided. The maximum number of 'addresses' you can track depends on the Data API plan you are subscribed to.","isRequired":true,"uniqueKey":"oneOf.1.metadata.keys","typeLabel":"string[]"},"subEvents":{"type":"object","description":"Sub-events to monitor","required":["addressActivitySubEvents"],"properties":{"addressActivitySubEvents":{"type":"array","items":{"type":"string","description":"Array of address activity sub-event types","enum":["balance_change","balance_threshold","reward_distribution"],"uniqueKey":"oneOf.1.metadata.subEvents.addressActivitySubEvents.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"oneOf.1.metadata.subEvents.addressActivitySubEvents","typeLabel":"enum\u003cstring>[]"}},"isRequired":true,"uniqueKey":"oneOf.1.metadata.subEvents","typeLabel":"object"},"eventSignatures":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.metadata.eventSignatures.items.[INDEX]","typeLabel":"string"},"description":"Array of hexadecimal strings of the event signatures.","example":["0x61cbb2a3dee0b6064c2e681aadd61677fb4ef319f0b547508d495626f5a62f64"],"uniqueKey":"oneOf.1.metadata.eventSignatures","typeLabel":"string[]"},"balanceThresholdFilter":{"type":"object","description":"Balance threshold filter","required":["balanceType","balanceThreshold"],"properties":{"balanceType":{"type":"string","description":"Type of balance to monitor","enum":["unlockedUnstaked","unlockedStaked","lockedPlatform","lockedStakeable","lockedStaked","pendingStaked","unlocked","locked","atomicMemoryUnlocked","atomicMemoryLocked"],"isRequired":true,"uniqueKey":"oneOf.1.metadata.balanceThresholdFilter.balanceType","typeLabel":"enum\u003cstring>"},"balanceThreshold":{"type":"string","description":"Threshold for balance corresponding to balanceType in nAVAX","isRequired":true,"uniqueKey":"oneOf.1.metadata.balanceThresholdFilter.balanceThreshold","typeLabel":"string"}},"uniqueKey":"oneOf.1.metadata.balanceThresholdFilter","typeLabel":"object"}},"isRequired":true,"uniqueKey":"oneOf.1.metadata","typeLabel":"object"},"name":{"type":"string","uniqueKey":"oneOf.1.name","typeLabel":"string"},"description":{"type":"string","uniqueKey":"oneOf.1.description","typeLabel":"string"}},"uniqueKey":"oneOf.1","typeLabel":"object"},{"type":"object","required":["eventType","url","network","metadata"],"properties":{"eventType":{"type":"string","enum":["validator_activity"],"isRequired":true,"uniqueKey":"oneOf.2.eventType","typeLabel":"enum\u003cstring>"},"url":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.url","typeLabel":"string"},"network":{"type":"string","enum":["mainnet","fuji"],"isRequired":true,"uniqueKey":"oneOf.2.network","typeLabel":"enum\u003cstring>"},"metadata":{"type":"object","description":"Metadata for platform validator activity event","required":["keyType","keys","subEvents"],"properties":{"keyType":{"type":"string","description":"The type of key to monitor for the validator activity event type.","enum":["nodeId","subnetId"],"isRequired":true,"uniqueKey":"oneOf.2.metadata.keyType","typeLabel":"enum\u003cstring>"},"keys":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.2.metadata.keys.items.[INDEX]","typeLabel":"string"},"description":"Array of keys like NodeID or SubnetID corresponding to the keyType being monitored. ValidatorActivity event will only accept a single key","isRequired":true,"uniqueKey":"oneOf.2.metadata.keys","typeLabel":"string[]"},"subEvents":{"type":"object","description":"Sub-events to monitor","required":["validatorActivitySubEvents"],"properties":{"validatorActivitySubEvents":{"type":"array","items":{"type":"string","enum":["validator_stake","delegator_stake","reward_distribution","l1_validator_balance_increased","l1_validator_disabled","l1_validator_removed","l1_validator_balance_threshold"],"uniqueKey":"oneOf.2.metadata.subEvents.validatorActivitySubEvents.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Array of validator activity sub-event types","isRequired":true,"uniqueKey":"oneOf.2.metadata.subEvents.validatorActivitySubEvents","typeLabel":"enum\u003cstring>[]"}},"isRequired":true,"uniqueKey":"oneOf.2.metadata.subEvents","typeLabel":"object"},"eventSignatures":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.2.metadata.eventSignatures.items.[INDEX]","typeLabel":"string"},"description":"Array of hexadecimal strings of the event signatures.","example":["0x61cbb2a3dee0b6064c2e681aadd61677fb4ef319f0b547508d495626f5a62f64"],"uniqueKey":"oneOf.2.metadata.eventSignatures","typeLabel":"string[]"},"nodeIds":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.2.metadata.nodeIds.items.[INDEX]","typeLabel":"string"},"description":"Array of node IDs to filter the events","uniqueKey":"oneOf.2.metadata.nodeIds","typeLabel":"string[]"},"subnetIds":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.2.metadata.subnetIds.items.[INDEX]","typeLabel":"string"},"description":"Array of subnet IDs to filter the events","uniqueKey":"oneOf.2.metadata.subnetIds","typeLabel":"string[]"},"l1ValidatorFeeBalanceThreshold":{"type":"string","description":"L1 validator fee balance threshold in nAVAX","uniqueKey":"oneOf.2.metadata.l1ValidatorFeeBalanceThreshold","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.2.metadata","typeLabel":"object"},"name":{"type":"string","uniqueKey":"oneOf.2.name","typeLabel":"string"},"description":{"type":"string","uniqueKey":"oneOf.2.description","typeLabel":"string"}},"uniqueKey":"oneOf.2","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"eventType":"address_activity","url":"\u003cstring>","chainId":"\u003cstring>","metadata":{"addresses":["0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E"],"eventSignatures":["0x61cbb2a3dee0b6064c2e681aadd61677fb4ef319f0b547508d495626f5a62f64"]},"name":"\u003cstring>","description":"\u003cstring>","includeInternalTxs":true,"includeLogs":true}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"f8e7b5bc-93b2-4057-8bc6-9ae6b8107c27":{"description":"Successful response","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["id","url","chainId","status","createdAt","name","description","eventType","metadata"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.id","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.url","typeLabel":"string"},"chainId":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.chainId","typeLabel":"string"},"status":{"type":"string","enum":["active","inactive"],"isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.createdAt","typeLabel":"number"},"name":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.name","typeLabel":"string"},"description":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.description","typeLabel":"string"},"eventType":{"type":"string","enum":["address_activity"],"isRequired":true,"uniqueKey":"oneOf.0.eventType","typeLabel":"enum\u003cstring>"},"metadata":{"type":"object","properties":{"addresses":{"description":"Ethereum address(es) for the address_activity event type. The maximum number of 'addresses' you can track depends on the Data API plan you are subscribed to.","examples":[["0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E"]],"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.metadata.addresses.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"oneOf.0.metadata.addresses","typeLabel":"string[]"},"eventSignatures":{"description":"Array of hexadecimal strings of the event signatures.","examples":[["0x61cbb2a3dee0b6064c2e681aadd61677fb4ef319f0b547508d495626f5a62f64"]],"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.metadata.eventSignatures.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.0.metadata.eventSignatures","typeLabel":"string[]"}},"required":["addresses"],"isRequired":true,"uniqueKey":"oneOf.0.metadata","typeLabel":"object"},"includeInternalTxs":{"type":"boolean","description":"Whether to include traces in the webhook payload.","uniqueKey":"oneOf.0.includeInternalTxs","typeLabel":"boolean"},"includeLogs":{"type":"boolean","description":"Whether to include logs in the webhook payload.","uniqueKey":"oneOf.0.includeLogs","typeLabel":"boolean"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["id","url","chainId","status","createdAt","name","description","eventType","metadata"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.id","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.url","typeLabel":"string"},"chainId":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.chainId","typeLabel":"string"},"status":{"type":"string","enum":["active","inactive"],"isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"number","isRequired":true,"uniqueKey":"oneOf.1.createdAt","typeLabel":"number"},"name":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.name","typeLabel":"string"},"description":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.description","typeLabel":"string"},"eventType":{"type":"string","enum":["primary_network_address_activity"],"isRequired":true,"uniqueKey":"oneOf.1.eventType","typeLabel":"enum\u003cstring>"},"metadata":{"type":"object","properties":{"keyType":{"type":"string","description":"The type of key to monitor for the address activity event type.","enum":["addresses"],"isRequired":true,"uniqueKey":"oneOf.1.metadata.keyType","typeLabel":"enum\u003cstring>"},"keys":{"description":"Array of keys like addresses corresponding to the keyType being monitored. For PrimaryNetworkAddressActivity event, an array of multiple addresses can be provided. The maximum number of 'addresses' you can track depends on the Data API plan you are subscribed to.","type":"array","items":{"type":"string","uniqueKey":"oneOf.1.metadata.keys.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"oneOf.1.metadata.keys","typeLabel":"string[]"},"subEvents":{"type":"object","description":"Sub-events to monitor","required":["addressActivitySubEvents"],"properties":{"addressActivitySubEvents":{"type":"array","items":{"type":"string","description":"Array of address activity sub-event types","enum":["balance_change","balance_threshold","reward_distribution"],"uniqueKey":"oneOf.1.metadata.subEvents.addressActivitySubEvents.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"oneOf.1.metadata.subEvents.addressActivitySubEvents","typeLabel":"enum\u003cstring>[]"}},"isRequired":true,"uniqueKey":"oneOf.1.metadata.subEvents","typeLabel":"object"},"eventSignatures":{"description":"Array of hexadecimal strings of the event signatures.","examples":[["0x61cbb2a3dee0b6064c2e681aadd61677fb4ef319f0b547508d495626f5a62f64"]],"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.metadata.eventSignatures.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.1.metadata.eventSignatures","typeLabel":"string[]"},"balanceThresholdFilter":{"type":"object","description":"Balance threshold filter","required":["balanceType","balanceThreshold"],"properties":{"balanceType":{"type":"string","description":"Type of balance to monitor","enum":["unlockedUnstaked","unlockedStaked","lockedPlatform","lockedStakeable","lockedStaked","pendingStaked","unlocked","locked","atomicMemoryUnlocked","atomicMemoryLocked"],"isRequired":true,"uniqueKey":"oneOf.1.metadata.balanceThresholdFilter.balanceType","typeLabel":"enum\u003cstring>"},"balanceThreshold":{"type":"string","description":"Threshold for balance corresponding to balanceType in nAVAX","isRequired":true,"uniqueKey":"oneOf.1.metadata.balanceThresholdFilter.balanceThreshold","typeLabel":"string"}},"uniqueKey":"oneOf.1.metadata.balanceThresholdFilter","typeLabel":"object"}},"required":["keyType","keys","subEvents"],"isRequired":true,"uniqueKey":"oneOf.1.metadata","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"object"},{"type":"object","required":["id","url","chainId","status","createdAt","name","description","eventType","metadata"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.id","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.url","typeLabel":"string"},"chainId":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.chainId","typeLabel":"string"},"status":{"type":"string","enum":["active","inactive"],"isRequired":true,"uniqueKey":"oneOf.2.status","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"number","isRequired":true,"uniqueKey":"oneOf.2.createdAt","typeLabel":"number"},"name":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.name","typeLabel":"string"},"description":{"type":"string","isRequired":true,"uniqueKey":"oneOf.2.description","typeLabel":"string"},"eventType":{"type":"string","enum":["validator_activity"],"isRequired":true,"uniqueKey":"oneOf.2.eventType","typeLabel":"enum\u003cstring>"},"metadata":{"type":"object","properties":{"keyType":{"type":"string","description":"The type of key to monitor for the validator activity event type.","enum":["nodeId","subnetId"],"isRequired":true,"uniqueKey":"oneOf.2.metadata.keyType","typeLabel":"enum\u003cstring>"},"keys":{"description":"Array of keys like NodeID or SubnetID corresponding to the keyType being monitored. ValidatorActivity event will only accept a single key","type":"array","items":{"type":"string","uniqueKey":"oneOf.2.metadata.keys.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"oneOf.2.metadata.keys","typeLabel":"string[]"},"subEvents":{"type":"object","description":"Sub-events to monitor","required":["validatorActivitySubEvents"],"properties":{"validatorActivitySubEvents":{"type":"array","description":"Array of validator activity sub-event types","items":{"type":"string","enum":["validator_stake","delegator_stake","reward_distribution","l1_validator_balance_increased","l1_validator_disabled","l1_validator_removed","l1_validator_balance_threshold"],"uniqueKey":"oneOf.2.metadata.subEvents.validatorActivitySubEvents.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"oneOf.2.metadata.subEvents.validatorActivitySubEvents","typeLabel":"enum\u003cstring>[]"}},"isRequired":true,"uniqueKey":"oneOf.2.metadata.subEvents","typeLabel":"object"},"eventSignatures":{"description":"Array of hexadecimal strings of the event signatures.","examples":[["0x61cbb2a3dee0b6064c2e681aadd61677fb4ef319f0b547508d495626f5a62f64"]],"type":"array","items":{"type":"string","uniqueKey":"oneOf.2.metadata.eventSignatures.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.2.metadata.eventSignatures","typeLabel":"string[]"},"nodeIds":{"description":"Array of node IDs to filter the events","type":"array","items":{"type":"string","uniqueKey":"oneOf.2.metadata.nodeIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.2.metadata.nodeIds","typeLabel":"string[]"},"subnetIds":{"description":"Array of subnet IDs to filter the events","type":"array","items":{"type":"string","uniqueKey":"oneOf.2.metadata.subnetIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.2.metadata.subnetIds","typeLabel":"string[]"},"l1ValidatorFeeBalanceThreshold":{"type":"string","description":"L1 validator fee balance threshold in nAVAX","uniqueKey":"oneOf.2.metadata.l1ValidatorFeeBalanceThreshold","typeLabel":"string"}},"required":["keyType","keys","subEvents"],"isRequired":true,"uniqueKey":"oneOf.2.metadata","typeLabel":"object"}},"uniqueKey":"oneOf.2","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","url":"\u003cstring>","chainId":"\u003cstring>","status":"active","createdAt":123,"name":"\u003cstring>","description":"\u003cstring>","eventType":"address_activity","metadata":{"addresses":["0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E"],"eventSignatures":["0x61cbb2a3dee0b6064c2e681aadd61677fb4ef319f0b547508d495626f5a62f64"]},"includeInternalTxs":true,"includeLogs":true}}},"exampleType":"generated"}},"exampleType":"generated"},"4bf83409-f3d6-4d3b-9049-0cd92f5d9b89":{"description":"Bad requests generally mean the client has passed invalid \n or malformed parameters. Error messages in the response could help in \n evaluating the error.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"oneOf":[{"type":"string","description":"The error message describing the reason for the exception","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"The error message describing the reason for the exception","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"statusCode":{"type":"number","description":"The HTTP status code of the response","examples":[400],"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","description":"The type of error","examples":["Bad Request"],"isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["message","statusCode","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","statusCode":400,"error":"Bad Request"}}},"exampleType":"generated"}},"exampleType":"generated"},"190f279e-1119-4d1a-b055-ac2605a44d1e":{"description":"When a client attempts to access resources that require \n authorization credentials but the client lacks proper authentication \n in the request, the server responds with 401.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"oneOf":[{"type":"string","description":"The error message describing the reason for the exception","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"The error message describing the reason for the exception","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"statusCode":{"type":"number","description":"The HTTP status code of the response","examples":[401],"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","description":"The type of error","examples":["Unauthorized"],"isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["message","statusCode","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","statusCode":401,"error":"Unauthorized"}}},"exampleType":"generated"}},"exampleType":"generated"},"cf6342c3-0b6a-4777-85b4-299dc187b107":{"description":"When a client attempts to access resources with valid\n credentials but doesn't have the privilege to perform that action, \n the server responds with 403.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"oneOf":[{"type":"string","description":"The error message describing the reason for the exception","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"The error message describing the reason for the exception","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"statusCode":{"type":"number","description":"The HTTP status code of the response","examples":[403],"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","description":"The type of error","examples":["Forbidden"],"isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["message","statusCode","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","statusCode":403,"error":"Forbidden"}}},"exampleType":"generated"}},"exampleType":"generated"},"8042517f-3480-466d-86f7-0369f8893121":{"description":"The error is mostly returned when the client requests\n with either mistyped URL, or the passed resource is moved or deleted, \n or the resource doesn't exist.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"oneOf":[{"type":"string","description":"The error message describing the reason for the exception","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"The error message describing the reason for the exception","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"statusCode":{"type":"number","description":"The HTTP status code of the response","examples":[404],"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","description":"The type of error","examples":["Not Found"],"isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["message","statusCode","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","statusCode":404,"error":"Not Found"}}},"exampleType":"generated"}},"exampleType":"generated"},"933f0573-dcb5-4554-a45d-da73f93dbc13":{"description":"This error is returned when the client has sent too many,\n and has hit the rate limit.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"oneOf":[{"type":"string","description":"The error message describing the reason for the exception","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"The error message describing the reason for the exception","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"statusCode":{"type":"number","description":"The HTTP status code of the response","examples":[429],"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","description":"The type of error","examples":["Too Many Requests"],"isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["message","statusCode","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","statusCode":429,"error":"Too Many Requests"}}},"exampleType":"generated"}},"exampleType":"generated"},"a9700821-1a1d-45d2-863e-bffddba29c6a":{"description":"The error is a generic server side error that is \n returned for any uncaught and unexpected issues on the server side. \n This should be very rare, and you may reach out to us if the problem \n persists for a longer duration.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"oneOf":[{"type":"string","description":"The error message describing the reason for the exception","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"The error message describing the reason for the exception","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"statusCode":{"type":"number","description":"The HTTP status code of the response","examples":[500],"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","description":"The type of error","examples":["Internal Server Error"],"isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["message","statusCode","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","statusCode":500,"error":"Internal Server Error"}}},"exampleType":"generated"}},"exampleType":"generated"},"549ed303-2d0b-41d8-89a7-94695e02af85":{"description":"This is an internal error indicating invalid response \n received by the client-facing proxy or gateway from the upstream server.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"oneOf":[{"type":"string","description":"The error message describing the reason for the exception","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"The error message describing the reason for the exception","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"statusCode":{"type":"number","description":"The HTTP status code of the response","examples":[502],"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","description":"The type of error","examples":["Bad Gateway"],"isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["message","statusCode","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","statusCode":502,"error":"Bad Gateway"}}},"exampleType":"generated"}},"exampleType":"generated"},"68026543-ee83-47a1-a10c-016f7b3b7e0c":{"description":"The error is returned for certain routes on a particular\n Subnet. This indicates an internal problem with our Subnet node, and may \n not necessarily mean the Subnet is down or affected.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"oneOf":[{"type":"string","description":"The error message describing the reason for the exception","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"message.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"The error message describing the reason for the exception","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | string[]"},"statusCode":{"type":"number","description":"The HTTP status code of the response","examples":[503],"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"error":{"type":"string","description":"The type of error","examples":["Service Unavailable"],"isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["message","statusCode","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","statusCode":503,"error":"Service Unavailable"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"573c8757-ee68-44b4-8976-3d873544a796":{"apiKey":{"type":"apiKey","in":"header","name":"x-glacier-api-key","description":"Api keys provide higher access to rate limits. To obtain an api key, sign up for an account at https://avacloud.io/.","scopes":[]}},"6ae389f9-883b-412b-a21f-b427663640ab":{}},"servers":{"537ad5f1-0b28-45d3-812a-1093461f71e4":{"url":"https://glacier-api.avax.network"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-glacier-api-key","description":"Api keys provide higher access to rate limits. To obtain an api key, sign up for an account at https://avacloud.io/.","scopes":[]},"schema":{"title":"x-glacier-api-key","type":"string","description":"Api keys provide higher access to rate limits. To obtain an api key, sign up for an account at https://avacloud.io/.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"x-glacier-api-key"}],"title":"apiKey"}]},"originalFileLocation":"data-api/data-api.yaml"},"subdomain":"avalabs-47ea3976","siteName":"Avalanche APIs \u0026 SDKs Documentation","title":"Create a webhook - Avalanche APIs \u0026 SDKs Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-09-05T11:37:49.114Z","originalFileLocation":"webhooks-api/webhooks/create-a-webhook.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create a new webhook.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Avalanche APIs \u0026amp; SDKs 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/avalabs-47ea3976/G_eb2HoilfFk1IGX/_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/avalabs-47ea3976/G_eb2HoilfFk1IGX/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/avalabs-47ea3976/G_eb2HoilfFk1IGX/_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/avalabs-47ea3976/G_eb2HoilfFk1IGX/_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/avalabs-47ea3976/G_eb2HoilfFk1IGX/_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/avalabs-47ea3976/G_eb2HoilfFk1IGX/_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/avalabs-47ea3976/G_eb2HoilfFk1IGX/_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/avalabs-47ea3976/G_eb2HoilfFk1IGX/_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/avalabs-47ea3976/G_eb2HoilfFk1IGX/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a webhook - Avalanche APIs \u0026amp; SDKs Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Accelerate your development across 100+ Layer 1 blockchains with powerful SDKs, APIs, guides, and tutorials.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Avalanche API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.avacloud.io/webhooks-api/webhooks/create-a-webhook\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://github.com/javiertc/image/blob/main/og-avalanche-api-documentation.png?raw=True\">\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=\"Avalanche API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Accelerate your development across 100+ Layer 1 blockchains with powerful SDKs, APIs, guides, and tutorials.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://github.com/javiertc/image/blob/main/og-avalanche-api-documentation.png?raw=True\">\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/avalabs-47ea3976/G_eb2HoilfFk1IGX/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Avalanche APIs \u0026amp; SDKs Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF394A\">\u003cmeta data-mint-head name=\"og:site_logo\" content=\"https://cdn.prod.website-files.com/632993e1d1acbfa5635afd0b/66e44b097229055c691e7555_AvalancheLogo_Horizontal_4C_White.svg\">\u003cmeta data-mint-head name=\"twitter:image:alt\" content=\"Avalanche API Documentation\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.avacloud.io/webhooks-api/webhooks/create-a-webhook\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/webhooks-api/webhooks/create-a-webhook.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.avacloud.io/#organization\",\"name\":\"Avalanche APIs \u0026 SDKs Documentation\",\"url\":\"https://developers.avacloud.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/avalabs-47ea3976/aMFVWopw05lo-Yr3/logo/logo-light.svg?fit=max\u0026auto=format\u0026n=aMFVWopw05lo-Yr3\u0026q=85\u0026s=58b1edd9671d525af4dad6fa86626763\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.avacloud.io#website\",\"name\":\"Avalanche APIs \u0026 SDKs Documentation\",\"url\":\"https://developers.avacloud.io\",\"publisher\":{\"@id\":\"https://developers.avacloud.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.avacloud.io/webhooks-api/webhooks/create-a-webhook#webpage\",\"url\":\"https://developers.avacloud.io/webhooks-api/webhooks/create-a-webhook\",\"name\":\"Create a webhook\",\"description\":\"Create a new webhook.\",\"dateModified\":\"2025-09-05T11:37:49.114Z\",\"isPartOf\":{\"@id\":\"https://developers.avacloud.io#website\"},\"breadcrumb\":{\"@id\":\"https://developers.avacloud.io/webhooks-api/webhooks/create-a-webhook#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.avacloud.io/webhooks-api/webhooks/create-a-webhook#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://developers.avacloud.io/webhooks-api/webhooks/list-webhooks\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a webhook\",\"item\":\"https://developers.avacloud.io/webhooks-api/webhooks/create-a-webhook\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.avacloud.io/webhooks-api/webhooks/create-a-webhook#apireference\",\"headline\":\"Create a webhook\",\"name\":\"Create a webhook\",\"description\":\"Create a new webhook.\",\"url\":\"https://developers.avacloud.io/webhooks-api/webhooks/create-a-webhook\",\"mainEntityOfPage\":{\"@id\":\"https://developers.avacloud.io/webhooks-api/webhooks/create-a-webhook#webpage\"},\"image\":\"https://github.com/javiertc/image/blob/main/og-avalanche-api-documentation.png?raw=True\",\"dateModified\":\"2025-09-05T11:37:49.114Z\",\"publisher\":{\"@id\":\"https://developers.avacloud.io/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.avacloud.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Avalanche APIs \u0026 SDKs Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Avalanche APIs \u0026 SDKs Documentation","nav":{"global":{"anchors":[{"anchor":"Builder Hub","icon":"laptop-code","href":"https://build.avax.network/"},{"anchor":"Academy","icon":"book-open-cover","href":"https://academy.avax.network/"},{"anchor":"Community","icon":"discord","href":"https://discord.gg/avax"}]},"tabs":[{"tab":"API Reference","pages":[{"title":"API Reference","href":"/introduction"}]},{"tab":"Data API","pages":[{"title":"Data API","href":"/data-api/overview"}]},{"tab":"Webhooks API","groups":[{"group":"Get Started","pages":[{"title":"Overview","icon":"ballot-check","href":"/webhooks-api/overview"},{"title":"Getting Started","icon":"rocket","mode":"wide","href":"/webhooks-api/getting-started"},{"title":"Webhook Signature","icon":"signature","mode":"wide","href":"/webhooks-api/signature"},{"title":"Supported EVM Chains","icon":"link","mode":"wide","href":"/webhooks-api/supported-chains"},{"title":"WebSockets vs Webhooks","icon":"swords-laser","mode":"wide","href":"/webhooks-api/wss-vs-webhooks"},{"title":"Retry mechanism","icon":"repeat","href":"/webhooks-api/retries"},{"title":"Rate Limits","icon":"monitor-waveform","href":"/webhooks-api/rate-limits"}]},{"group":"Platform Webhooks(BETA)","pages":[{"title":"Platform Webhooks","icon":"layer-group","href":"/webhooks-api/platform-webhooks"},{"title":"Address Activity","icon":"wallet","href":"/webhooks-api/platform-webhooks-address"},{"title":"Validator Activity","icon":"box","href":"/webhooks-api/platform-webhooks-validator"}]},{"group":"Tutorials","pages":[{"title":"Monitoring multiple addresses","icon":"wallet","mode":"wide","href":"/webhooks-api/multiple"},{"title":"Track ERC-20 Transfers","icon":"money-bill-transfer","mode":"wide","href":"/webhooks-api/erc20-transfers"},{"title":"Track ERC-721 Transfers","icon":"hexagon-vertical-nft","mode":"wide","href":"/webhooks-api/erc721-transfers"},{"title":"Send Push notification","icon":"bell","mode":"wide","href":"/webhooks-api/push-notifications"}]},{"group":"API Reference","pages":[{"openapi":"get /v1/webhooks","title":"List webhooks","description":"Lists webhooks for the user.","href":"/webhooks-api/webhooks/list-webhooks"},{"openapi":"post /v1/webhooks","title":"Create a webhook","href":"/webhooks-api/webhooks/create-a-webhook"},{"openapi":"get /v1/webhooks/{id}","title":"Get a webhook by ID","description":"Retrieves a webhook by ID.","href":"/webhooks-api/webhooks/get-a-webhook-by-id"},{"openapi":"delete /v1/webhooks/{id}","title":"Deactivate a webhook","href":"/webhooks-api/webhooks/deactivate-a-webhook"},{"openapi":"patch /v1/webhooks/{id}","title":"Update a webhook","href":"/webhooks-api/webhooks/update-a-webhook"},{"openapi":"post /v1/webhooks:generateOrRotateSharedSecret","title":"Generate or rotate a shared secret","href":"/webhooks-api/webhooks/generate-a-shared-secret"},{"openapi":"get /v1/webhooks:getSharedSecret","title":"Get a shared secret","href":"/webhooks-api/webhooks/get-a-shared-secret"},{"openapi":"get /v1/webhooks/{id}/addresses","title":"List adresses by EVM activity webhooks","href":"/webhooks-api/webhooks/list-adresses-by-webhook"},{"openapi":"delete /v1/webhooks/{id}/addresses","title":"Remove addresses from EVM activity webhook","href":"/webhooks-api/webhooks/remove-addresses-from-webhook"},{"openapi":"patch /v1/webhooks/{id}/addresses","title":"Add addresses to EVM activity webhook","href":"/webhooks-api/webhooks/add-addresses-to-webhook"}]}]},{"tab":"Metrics API","pages":[{"title":"Metrics API","href":"/metrics-api/overview"}]},{"tab":"RPC API","pages":[{"title":"RPC API","href":"/rpc-api/overview"}]},{"tab":"Avalanche SDK","pages":[{"title":"Avalanche SDK","href":"/avalanche-sdk/overview"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/changelog"}]}]},"basePath":"","title":"Create a webhook - Avalanche APIs \u0026 SDKs Documentation","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}