Optional event metadata. You can add, remove, or modify any properties as needed for your use case.
Show child attributes
Response
Accepted - Event tracking successful
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Userpilot Knowledge Base","colors":{"primary":"#6765e8","light":"#9a98f0","dark":"#343374"},"logo":{"light":"https://mintcdn.com/userpilot/KtUQBkEo7Hf3bjCu/up-logo-dark.svg?fit=max\u0026auto=format\u0026n=KtUQBkEo7Hf3bjCu\u0026q=85\u0026s=ed5988b05e17770537d7327506be349c","dark":"https://mintcdn.com/userpilot/KtUQBkEo7Hf3bjCu/up-logo-light.svg?fit=max\u0026auto=format\u0026n=KtUQBkEo7Hf3bjCu\u0026q=85\u0026s=2558daac7455ff6275b45a01cecb8ca9"},"favicon":"https://mintcdn.com/userpilot/KtUQBkEo7Hf3bjCu/up-favicon.svg?fit=max\u0026auto=format\u0026n=KtUQBkEo7Hf3bjCu\u0026q=85\u0026s=bd3fb42ae91a32d13d543fed45a8b88e","footer":{"socials":{"twitter":"https://linkedin.com/company/teamuserpilot","facebook":"https://facebook.com/userpilot","linkedin":"https://linkedin.com/company/teamuserpilot"},"links":[{"header":"Support","items":[{"label":"support@userpilot.com","href":"mailto:support@userpilot.com"}]}]},"seo":{"metatags":{"canonical":"https://docs.userpilot.com","og:site_name":"Userpilot Knowledge Base","og:type":"website","og:image":"https://docs.userpilot.com/up-logo-dark.svg","twitter:card":"summary_large_image","twitter:site":"@usaborpilot"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"userpilot","hasAudioNarration":false,"actualSubdomain":"userpilot","customDomains":["docs.userpilot.com"],"gitSource":{"type":"github","owner":"userpilot","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae0b2192ea1296893eaac7f","collectionId":"fc844142-bc45-4b7f-9358-b6510c66635c","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae0b2192ea1296893eaac7f"},"feedback":{"edits":true,"issues":true,"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae7105b88760f93b1002721","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Platform","count":137},{"language":"default","tag":"Developer","count":88},{"language":"default","tag":"Installation","count":76},{"language":"default","tag":"Mobile","count":68},{"language":"default","tag":"In App Engagement","count":56},{"language":"default","tag":"APIs","count":42},{"language":"default","tag":"Configure","count":23},{"language":"default","tag":"Endpoints","count":20},{"language":"default","tag":"Bulk Export","count":17},{"language":"default","tag":"Integrations","count":14}]},"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":[{"filePath":"style.css","content":":root{--primary:103 101 232;--primary-light:225 224 250;--primary-dark:103 101 232;--background-light:255 255 255;--background-dark:9 13 13;--gray-50:243 247 246;--gray-100:238 242 241;--gray-200:222 226 226;--gray-300:206 210 209;--gray-400:158 163 162;--gray-500:112 116 115;--gray-600:80 84 83;--gray-700:62 67 66;--gray-800:37 41 40;--gray-900:23 27 26;--gray-950:10 14 13;--header:128 127 236;--hover-btn:52 51 116;--accent:103 101 232}header#header>div>div{color:rgb(var(--header))}body :is(.dark\\:bg-primary-light:is(.dark *)){background:rgb(var(--accent))}body :is(.dark\\:bg-primary-light\\/10:is(.dark *)){background:rgb(var(--hover-btn))}"}],"page":{"pagePath":"api-references/endpoints/realtime/track-event","slug":"/api-references/endpoints/realtime/track-event","pageMetadata":{"title":"Track Event","description":"Record a custom event for a user with optional metadata properties via HTTP POST request.","keywords":["Userpilot","Track","Event","API","Endpoints","Realtime"],"openapi":"POST /v1/track","href":"/api-references/endpoints/realtime/track-event"},"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: \"Record a custom event for a user with optional metadata properties via HTTP POST request.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Track Event","description":"Record a custom event for a user with optional metadata properties via HTTP POST request.","keywords":["Userpilot","Track","Event","API","Endpoints","Realtime"],"openapi":"POST /v1/track","href":"/api-references/endpoints/realtime/track-event"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/userpilot/3ace2e9458eac66f/.prettierrc.js","/_mintlify/custom/userpilot/27d7e6557bc674e7/plausible.js","/_mintlify/custom/userpilot/222114e09e9d43ba/scripts/generate-kb-manifest.js","/_mintlify/custom/userpilot/7588c52f105b4ce6/scripts/check-nav.js","/_mintlify/custom/userpilot/77c4aabf1776912c/scripts/check-redirects.js","/_mintlify/custom/userpilot/c4efe6226e95d900/scripts/lib/docs-lib.js","/_mintlify/custom/userpilot/8278790c2c1428e5/scripts/precommit.js","/_mintlify/custom/userpilot/826df8c2727af7c1/scripts/seo-audit.js"],"openApiReferenceData":{"operation":{"summary":"Track Events","parameters":["f8ce6c4d-f21c-4efe-a00d-8893a3580f01","5a1253a6-d7b9-405f-983a-b975294745ab","d8d04029-9672-48b9-9fb6-4f8a722b0eda"],"responses":{"202":"d362561f-6e03-4ae2-b00b-5cbaa73f5c39","400":"aea47d5d-4a88-4ae6-a8c7-51ea3b9e8a6d","401":"83fe5240-4748-4043-95bb-9160a65bd454"},"requestBody":"c76e8b7b-e2dd-4395-a1bd-456cb1b88495","method":"post","type":"path","servers":["2c76810c-3365-4747-a4fb-d93080966d7b"],"security":[],"path":"/v1/track","baseUrlOptions":["https://{environment}.userpilot.io"],"title":"Track Events","description":"Record a custom event for a user with optional metadata properties via HTTP POST request.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"f8ce6c4d-f21c-4efe-a00d-8893a3580f01":{"name":"Content-Type","in":"header","required":false,"example":"application/json","schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"}},"5a1253a6-d7b9-405f-983a-b975294745ab":{"name":"Accept","in":"header","required":false,"example":"application/json","schema":{"type":"string","isRequired":false,"uniqueKey":"","typeLabel":"string"}},"d8d04029-9672-48b9-9fb6-4f8a722b0eda":{"name":"Authorization","in":"header","required":true,"description":"API authentication token in the format: `Token {{API_KEY}}`\nObtain your API key from the [Userpilot Environment Settings](https://run.userpilot.io/environment).","schema":{"type":"string","default":"Token ABC_1234_EFGH_5678","isRequired":true,"description":"API authentication token in the format: `Token {{API_KEY}}`\nObtain your API key from the [Userpilot Environment Settings](https://run.userpilot.io/environment).","uniqueKey":"","typeLabel":"string"},"example":"Token ABC_1234_EFGH_5678"}},"requestBody":{"content":{"application/json":{"example":{"user_id":"user_789456","event_name":"schedule_appointment","metadata":{"appointment_date":"2024-02-01T10:00:00Z","appointment_type":"Initial Consultation","scheduled_by":"Sarah Johnson","specialty":"Cardiology","provider_id":"dr_smith_123","appointment_status":"confirmed"}},"schema":{"type":"object","required":["user_id","event_name"],"properties":{"user_id":{"type":"string","description":"The unique identifier for the user. This is the ID that Userpilot uses to identify the user.","example":"user_789456","isRequired":true,"uniqueKey":"user_id","typeLabel":"string"},"event_name":{"type":"string","description":"Name of the event being tracked. Use descriptive names like 'schedule_appointment', 'purchase_completed', etc.","example":"schedule_appointment","isRequired":true,"uniqueKey":"event_name","typeLabel":"string"},"metadata":{"type":"object","description":"Optional event metadata. You can add, remove, or modify any properties as needed for your use case.","additionalProperties":true,"properties":{"custom_event_property":{"type":"string","description":"example: Date and time of the appointment, Product name, etc.","uniqueKey":"metadata.custom_event_property","typeLabel":"string"}},"uniqueKey":"metadata","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"user_id":"user_789456","event_name":"schedule_appointment","metadata":{"appointment_date":"2024-02-01T10:00:00Z","appointment_type":"Initial Consultation","scheduled_by":"Sarah Johnson","specialty":"Cardiology","provider_id":"dr_smith_123","appointment_status":"confirmed"}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"d362561f-6e03-4ae2-b00b-5cbaa73f5c39":{"headers":{"Content-Type":{"schema":{"type":"string"},"example":"application/json"}},"description":"Accepted - Event tracking successful","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"aea47d5d-4a88-4ae6-a8c7-51ea3b9e8a6d":{"headers":{"Content-Type":{"schema":{"type":"string","default":"application/json"},"example":"application/json"}},"description":"Bad Request - Invalid input","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"details":{"type":"string","uniqueKey":"errors.items.[INDEX].details","typeLabel":"string"},"error":{"type":"string","uniqueKey":"errors.items.[INDEX].error","typeLabel":"string"},"error_code":{"type":"string","format":"color","uniqueKey":"errors.items.[INDEX].error_code","typeLabel":"string\u003ccolor>"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"details":"\u003cstring>","error":"\u003cstring>","error_code":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"83fe5240-4748-4043-95bb-9160a65bd454":{"headers":{"Content-Type":{"schema":{"type":"string","default":"application/json"},"example":"application/json"}},"description":"Unauthorized - Invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"details":{"type":"string","uniqueKey":"errors.items.[INDEX].details","typeLabel":"string"},"error":{"type":"string","uniqueKey":"errors.items.[INDEX].error","typeLabel":"string"},"error_code":{"type":"string","format":"color","uniqueKey":"errors.items.[INDEX].error_code","typeLabel":"string\u003ccolor>"},"message":{"type":"string","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"details":"\u003cstring>","error":"\u003cstring>","error_code":"\u003cstring>","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"2c76810c-3365-4747-a4fb-d93080966d7b":{"url":"https://{environment}.userpilot.io","description":"Analytical data endpoint for Userpilot API. Choose the appropriate environment based on your data residency requirements and account type.","variables":{"environment":{"description":"The Userpilot environment endpoint for your account. Most customers use the default US region (analytex), while EU customers with data residency requirements use the EU region (analytex-eu). You can find your specific endpoint URL in your Userpilot dashboard under [Environment Settings](https://run.userpilot.io/environment).","enum":["analytex","analytex-eu"],"default":"analytex"}}}}},"originalFileLocation":"api-references/analytex.json"},"subdomain":"userpilot","siteName":"Userpilot Knowledge Base","title":"Track Event - Userpilot Knowledge Base","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-28T09:23:46.173Z","originalFileLocation":"api-references/endpoints/realtime/track-event.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=\"Record a custom event for a user with optional metadata properties via HTTP POST request.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Userpilot Knowledge Base\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/userpilot/aR1cLyV1TsYivBqB/_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/userpilot/aR1cLyV1TsYivBqB/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/userpilot/aR1cLyV1TsYivBqB/_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/userpilot/aR1cLyV1TsYivBqB/_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/userpilot/aR1cLyV1TsYivBqB/_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/userpilot/aR1cLyV1TsYivBqB/_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/userpilot/aR1cLyV1TsYivBqB/_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/userpilot/aR1cLyV1TsYivBqB/_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/userpilot/aR1cLyV1TsYivBqB/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Track Event - Userpilot Knowledge Base\">\u003cmeta data-mint-head property=\"og:description\" content=\"Record a custom event for a user with optional metadata properties via HTTP POST request.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Userpilot Knowledge Base\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.userpilot.com/api-references/endpoints/realtime/track-event\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docs.userpilot.com/up-logo-dark.svg\">\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=\"Track Event - Userpilot Knowledge Base\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Record a custom event for a user with optional metadata properties via HTTP POST request.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docs.userpilot.com/up-logo-dark.svg\">\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/userpilot/aR1cLyV1TsYivBqB/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Userpilot Knowledge Base\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6765e8\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.userpilot.com/api-references/endpoints/realtime/track-event\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-references/endpoints/realtime/track-event.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.userpilot.com/#organization\",\"name\":\"Userpilot Knowledge Base\",\"url\":\"https://docs.userpilot.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/userpilot/KtUQBkEo7Hf3bjCu/up-logo-dark.svg?fit=max\u0026auto=format\u0026n=KtUQBkEo7Hf3bjCu\u0026q=85\u0026s=ed5988b05e17770537d7327506be349c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.userpilot.com#website\",\"name\":\"Userpilot Knowledge Base\",\"url\":\"https://docs.userpilot.com\",\"publisher\":{\"@id\":\"https://docs.userpilot.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.userpilot.com/api-references/endpoints/realtime/track-event#webpage\",\"url\":\"https://docs.userpilot.com/api-references/endpoints/realtime/track-event\",\"name\":\"Track Event\",\"description\":\"Record a custom event for a user with optional metadata properties via HTTP POST request.\",\"dateModified\":\"2026-01-28T09:23:46.173Z\",\"isPartOf\":{\"@id\":\"https://docs.userpilot.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.userpilot.com/api-references/endpoints/realtime/track-event#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.userpilot.com/api-references/endpoints/realtime/track-event#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Real-time HTTP\",\"item\":\"https://docs.userpilot.com/api-references/real-time/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Endpoints\",\"item\":\"https://docs.userpilot.com/api-references/endpoints/realtime/identify-user\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Track Event\",\"item\":\"https://docs.userpilot.com/api-references/endpoints/realtime/track-event\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.userpilot.com/api-references/endpoints/realtime/track-event#apireference\",\"headline\":\"Track Event\",\"name\":\"Track Event\",\"description\":\"Record a custom event for a user with optional metadata properties via HTTP POST request.\",\"url\":\"https://docs.userpilot.com/api-references/endpoints/realtime/track-event\",\"mainEntityOfPage\":{\"@id\":\"https://docs.userpilot.com/api-references/endpoints/realtime/track-event#webpage\"},\"image\":\"https://docs.userpilot.com/up-logo-dark.svg\",\"dateModified\":\"2026-01-28T09:23:46.173Z\",\"keywords\":\"Userpilot, Track, Event, API, Endpoints, Realtime\",\"publisher\":{\"@id\":\"https://docs.userpilot.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.userpilot.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Userpilot Knowledge Base\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Userpilot Knowledge Base","nav":{"global":null,"tabs":[{"tab":"Platform","pages":[{"title":"Platform","href":"/getting-started/what-is-userpilot"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"Developer","pages":[{"title":"Developer","href":"/developer/installation/web"}]},{"tab":"APIs","groups":[{"group":"APIs","icon":"rectangle-terminal","pages":[{"title":"Userpilot API Documentation","sidebarTitle":"Overview","mode":"wide","href":"/api-references/overview"},{"title":"Authentication","href":"/api-references/authentication"},{"title":"Environment","href":"/api-references/environment"}]},{"group":"Real-time HTTP","pages":[{"title":"Overview","href":"/api-references/real-time/overview"},{"title":"Identify User","href":"/api-references/real-time/identify-user"},{"title":"Identify Company","href":"/api-references/real-time/identify-company"},{"title":"Track Event","href":"/api-references/real-time/track-event"},{"group":"Endpoints","pages":[{"title":"Identify User","openapi":"POST /v1/identify","href":"/api-references/endpoints/realtime/identify-user"},{"title":"Identify Company","description":"Create or update a company profile with properties like name, industry, and size via HTTP POST request.","openapi":"POST /v1/companies/identify","href":"/api-references/endpoints/realtime/identify-company"},{"title":"Track Event","openapi":"POST /v1/track","href":"/api-references/endpoints/realtime/track-event"}]}]},{"group":"Bulk Identify/Update","pages":[{"title":"Bulk Identify/Update Users","sidebarTitle":"Users","description":"Bulk identify and update user profiles using Userpilot's HTTP API for large-scale user data synchronization.","href":"/api-references/bulk-updates/users"},{"title":"Bulk Identify/Update Companies","sidebarTitle":"Companies","href":"/api-references/bulk-updates/companies"},{"group":"Endpoints","pages":[{"title":"Bulk Users Update","sidebarTitle":"Users","openapi":"POST /v1/users/bulk_identify","href":"/api-references/endpoints/bulk/users"},{"title":"Bulk Companies Update","sidebarTitle":"Companies","openapi":"POST /v1/companies/bulk_identify","href":"/api-references/endpoints/bulk/companies"},{"title":"List Jobs","openapi":"GET /v1/background_jobs","href":"/api-references/endpoints/jobs/list"},{"title":"View Job ID","openapi":"GET /v1/background_jobs/{{job_id}}","href":"/api-references/endpoints/jobs/job-id"}]}]},{"group":"Bulk Import","pages":[{"title":"Events Bulk Import","sidebarTitle":"Overview","href":"/api-references/import/overview"},{"title":"Event Schema","href":"/api-references/import/event-schema"},{"title":"Row Validation Rules","href":"/api-references/import/row-validation"},{"title":"User \u0026 Company Accumulative Properties Best Practices","sidebarTitle":"Best Practices","href":"/api-references/import/best-practices"},{"group":"Endpoints","pages":[{"title":"Import Job","openapi":"POST /v1/imports","href":"/api-references/endpoints/import/import-job"},{"title":"List Jobs","openapi":"GET /v1/background_jobs","href":"/api-references/endpoints/jobs/list"},{"title":"View Job ID","openapi":"GET /v1/background_jobs/{{job_id}}","href":"/api-references/endpoints/jobs/job-id"}]}]},{"group":"Bulk Export","pages":[{"title":"Bulk Data Export API","sidebarTitle":"Overview","href":"/api-references/export/overview"},{"title":"Event Schema","sidebarTitle":"Event Schema","href":"/api-references/export/event-schema"},{"title":"Data Lookups","sidebarTitle":"Data Lookups","href":"/api-references/export/lookups"},{"group":"Endpoints","pages":[{"title":"Export Job","sidebarTitle":"Export Job","openapi":"POST /api/v1/analytics/exports","href":"/api-references/endpoints/export/export-job"},{"title":"List Jobs","openapi":"GET /v1/background_jobs","href":"/api-references/endpoints/jobs/list"},{"title":"View Job ID","openapi":"GET /v1/background_jobs/{{job_id}}","href":"/api-references/endpoints/jobs/job-id"},{"group":"Lookups","pages":[{"title":"User Properties","sidebarTitle":"User Properties","openapi":"GET /api/v1/analytics/exports/lookups/user_properties","href":"/api-references/endpoints/lookups/user-properties"},{"title":"Company Properties","sidebarTitle":"Company Properties","openapi":"GET /api/v1/analytics/exports/lookups/company_properties","href":"/api-references/endpoints/lookups/company-properties"},{"title":"Segments","sidebarTitle":"Segments","openapi":"GET /api/v1/analytics/exports/lookups/segments","href":"/api-references/endpoints/lookups/segments"},{"title":"Features \u0026 Events","sidebarTitle":"Features \u0026 Events","openapi":"GET /api/v1/analytics/exports/lookups/features_events","href":"/api-references/endpoints/lookups/features-events"},{"title":"Flows","sidebarTitle":"Flows","openapi":"GET /api/v1/analytics/exports/lookups/flows","href":"/api-references/endpoints/lookups/flows"},{"title":"Banners","sidebarTitle":"Banners","openapi":"GET /api/v1/analytics/exports/lookups/banners","href":"/api-references/endpoints/lookups/banners"},{"title":"Embeds","sidebarTitle":"Embeds","openapi":"GET /api/v1/analytics/exports/lookups/embeds","href":"/api-references/endpoints/lookups/embeds"},{"title":"Spotlights","sidebarTitle":"Spotlights","openapi":"GET /api/v1/analytics/exports/lookups/spotlights","href":"/api-references/endpoints/lookups/spotlights"},{"title":"Checklists","sidebarTitle":"Checklists","openapi":"GET /api/v1/analytics/exports/lookups/checklists","href":"/api-references/endpoints/lookups/checklists"},{"title":"Surveys","sidebarTitle":"Surveys","openapi":"GET /api/v1/analytics/exports/lookups/surveys","href":"/api-references/endpoints/lookups/surveys"},{"title":"Resource Center Modules","sidebarTitle":"Resource Center Modules","openapi":"GET /api/v1/analytics/exports/lookups/resource_center_modules","href":"/api-references/endpoints/lookups/resource-center-modules"}]}]}]},{"group":"Email Subscriptions","pages":[{"title":"List Subscription Topics","href":"/api-references/email-subscriptions/list-topics"},{"title":"Set Subscription Preferences","href":"/api-references/email-subscriptions/set-preferences"}]},{"group":"Bulk Delete","pages":[{"title":"Delete Users and Companies","sidebarTitle":"Overview","href":"/api-references/delete/overview"}]}]}]},"basePath":"","title":"Track Event - Userpilot Knowledge Base","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}