optionally one additional audit or dead-letter endpoint
avoid pointing the same merchant to too many downstream consumers unless you truly need fan-out
Dashboard vs API
You can manage webhooks through the Business dashboard or the API. The API is recommended if you want repeatable environment setup through scripts.See Webhooks overview for the quickstart example and API reference for schema details.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Points","description":"Points API - Saudi Arabia's unified loyalty rewards platform","colors":{"primary":"#000000","light":"#111111","dark":"#5F4BE8"},"logo":{"light":"https://mintcdn.com/pointsapp/d74aWCsg391wAlk5/logo/points-logo-color.png?fit=max\u0026auto=format\u0026n=d74aWCsg391wAlk5\u0026q=85\u0026s=948090094e80ad893bd7f2ba254ca31c","dark":"https://mintcdn.com/pointsapp/oxmfII8INceQ313p/logo/points-logo-white.png?fit=max\u0026auto=format\u0026n=oxmfII8INceQ313p\u0026q=85\u0026s=34ab56ecbd2833b1977920e281a43693"},"favicon":"https://mintcdn.com/pointsapp/kYoPqa0DFrqfHgKX/favicon.png?fit=max\u0026auto=format\u0026n=kYoPqa0DFrqfHgKX\u0026q=85\u0026s=f1d2992a8a2e13e0f9adde38d964980f","background":{},"navbar":{"links":[{"href":"mailto:support@papp.sa","label":"Support"}],"primary":{"type":"button","label":"Register","href":"https://business.papp.sa"}},"footer":{"socials":{"x":"https://x.com/PointsAppSa","instagram":"https://instagram.com/pointsappsa","linkedin":"https://linkedin.com/company/pointsappsa"}},"seo":{"metatags":{"title":"Points API Documentation","description":"Official developer documentation for the Points API — Saudi Arabia's unified loyalty rewards platform.","application-name":"Points","og:title":"Points API Documentation","og:description":"Official developer documentation for the Points API — Saudi Arabia's unified loyalty rewards platform.","og:site_name":"Points","og:locale":"en_US","twitter:title":"Points API Documentation","twitter:description":"Official developer documentation for the Points API — Saudi Arabia's unified loyalty rewards platform."},"indexing":"navigable"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pointsapp","hasAudioNarration":false,"actualSubdomain":"pointsapp","customDomains":["docs.papp.sa"],"gitSource":{"type":"github","owner":"ibtikarat","repo":"points-docs","deployBranch":"master","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae95558b4f7670642c61cd0:success","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"Documentation","count":21},{"language":"default","tag":"API Reference","count":18},{"language":"default","tag":"Orders","count":11},{"language":"default","tag":"Webhooks","count":9},{"language":"default","tag":"Integration Guide","count":4},{"language":"default","tag":"Introduction","count":4},{"language":"default","tag":"Authentication","count":3},{"language":"default","tag":"E-commerce Platforms","count":2},{"language":"default","tag":"Testing","count":2},{"language":"default","tag":"Widgets","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@font-face{font-family:\"Ping AR + LT\";src:url(\"/fonts/PingARLT-Regular.woff2\") format(\"woff2\");font-style:normal;font-weight:400;font-display:swap}:root{--points-black: #000000;--points-black-hover: #1f1f1f;--points-purple: #5f4be8;--points-purple-hover: #7868ff;--points-purple-soft: rgba(95, 75, 232, 0.16)}html,body,button,input,textarea,select{font-family:\"Ping AR + LT\", ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, \"Segoe UI\", sans-serif!important}h1,h2,h3,h4,h5,h6,#content-area,#content-area *,[class*=\"prose\"],[class*=\"prose\"] *{font-family:\"Ping AR + LT\", ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, \"Segoe UI\", sans-serif!important}body::before{content:\"\";position:fixed;inset:0 0 auto 0;height:360px;pointer-events:none;z-index:0;background:radial-gradient(58rem 18rem at 58% -7%, var(--points-purple-soft), transparent 72%),\n radial-gradient(42rem 14rem at 32% -4%, rgba(95, 75, 232, 0.10), transparent 76%),\n linear-gradient(180deg, rgba(95, 75, 232, 0.055), transparent 74%);filter:blur(18px)}body>div.relative.antialiased{position:relative;z-index:1}#topbar-cta-button a>span.absolute.inset-0,button[class*=\"bg-primary\"]:not([class*=\"/\"]),a[class*=\"bg-primary\"]:not([class*=\"/\"]){background-color:var(--points-black)!important;transition:background-color 160ms ease, opacity 160ms ease}#topbar-cta-button a:hover>span.absolute.inset-0,button[class*=\"bg-primary\"]:not([class*=\"/\"]):hover,a[class*=\"bg-primary\"]:not([class*=\"/\"]):hover{background-color:var(--points-black-hover)!important;opacity:1!important}.dark body::before{background:radial-gradient(58rem 18rem at 58% -7%, rgba(95, 75, 232, 0.34), transparent 72%),\n radial-gradient(42rem 14rem at 32% -4%, rgba(120, 104, 255, 0.22), transparent 76%),\n linear-gradient(180deg, rgba(95, 75, 232, 0.16), transparent 74%)}.dark #topbar-cta-button a>span.absolute.inset-0,.dark button[class*=\"bg-primary\"]:not([class*=\"/\"]),.dark a[class*=\"bg-primary\"]:not([class*=\"/\"]){background-color:var(--points-purple)!important}.dark #topbar-cta-button a:hover>span.absolute.inset-0,.dark button[class*=\"bg-primary\"]:not([class*=\"/\"]):hover,.dark a[class*=\"bg-primary\"]:not([class*=\"/\"]):hover{background-color:var(--points-purple-hover)!important}html:not(.dark) [class*=\"text-primary\"],html:not(.dark) [class*=\"border-primary\"]{color:var(--points-black)!important;border-color:var(--points-black)!important}.dark [class*=\"text-primary\"],.dark [class*=\"border-primary\"]{color:var(--points-purple)!important;border-color:var(--points-purple)!important}#content-area::before{content:\"\";position:fixed;top:-10%;left:50%;transform:translateX(-50%);width:70%;height:500px;background:radial-gradient(\n ellipse at center,\n rgba(95, 75, 232, 0.18) 0%,\n rgba(95, 75, 232, 0.10) 35%,\n rgba(95, 75, 232, 0.04) 65%,\n transparent 80%\n );filter:blur(90px);pointer-events:none;z-index:0}#content-area::after{content:\"\";position:fixed;top:40%;right:-5%;width:450px;height:450px;background:radial-gradient(\n circle,\n rgba(95, 75, 232, 0.08) 0%,\n transparent 70%\n );filter:blur(100px);pointer-events:none;z-index:0}#content-area>*{position:relative;z-index:1}@media (max-width: 768px){#content-area::before{width:100%;height:300px;filter:blur(60px)}#content-area::after{display:none}}.dark #content-area::before{background:radial-gradient(\n ellipse at center,\n rgba(95, 75, 232, 0.26) 0%,\n rgba(120, 104, 255, 0.14) 35%,\n rgba(95, 75, 232, 0.06) 65%,\n transparent 80%\n )}.dark #content-area::after{background:radial-gradient(\n circle,\n rgba(120, 104, 255, 0.12) 0%,\n transparent 70%\n )}a[href*=\"?assistant=open\"],a[href*=\"?assistant=\"],button[aria-label*=\"Ask AI\"i],button[aria-label*=\"assistant\"i],[data-testid*=\"assistant\"i],[class*=\"assistant-bar\"i],[class*=\"assistant-fab\"i]{display:none!important}"}],"page":{"pagePath":"webhooks/management","slug":"/webhooks/management","pageMetadata":{"title":"Webhook Management","description":"Create, list, update, and delete webhook endpoints","href":"/webhooks/management"},"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, list, update, and delete webhook endpoints\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Points lets each merchant manage webhook endpoints over the API.`}),`\n`,_jsx(_components.p,{children:`Available operations:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`GET /v1/webhooks`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`POST /v1/webhooks`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`GET /v1/webhooks/{uuid}`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`PUT / PATCH /v1/webhooks/{uuid}`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`DELETE /v1/webhooks/{uuid}`})}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`All webhook management endpoints require `,_jsx(_components.code,{children:`x-api-key`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`create`,children:`Create`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`7`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://business.papp.sa/api/v1/webhooks`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"x-api-key: `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$POINTS_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"name\": \"Order Notifications\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"url\": \"https://merchant.example.com/webhooks/points\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})}),`\n`,_jsx(_components.p,{children:`Response fields include:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`uuid`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`merchant_id`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`name`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`url`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`secret`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`created_at`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`updated_at`})}),`\n`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Persist the returned `,_jsx(_components.code,{children:`secret`}),` securely at creation time. Your webhook consumer needs it to verify authenticity.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`list`,children:`List`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://business.papp.sa/api/v1/webhooks`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"x-api-key: `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$POINTS_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Accept: application/json\"`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Current backend behavior paginates the results. You can pass `,_jsx(_components.code,{children:`per_page`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`retrieve-one-webhook`,children:`Retrieve one webhook`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://business.papp.sa/api/v1/webhooks/550e8400-e29b-41d4-a716-446655440000`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"x-api-key: `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$POINTS_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Accept: application/json\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`update`,children:`Update`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`7`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` PATCH`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://business.papp.sa/api/v1/webhooks/550e8400-e29b-41d4-a716-446655440000`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"x-api-key: `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$POINTS_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"name\": \"Primary Order Webhook\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"url\": \"https://merchant.example.com/webhooks/points-v2\"`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`delete`,children:`Delete`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`2`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` DELETE`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://business.papp.sa/api/v1/webhooks/550e8400-e29b-41d4-a716-446655440000`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"x-api-key: `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`$POINTS_API_KEY`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`validation-and-operational-rules`,children:`Validation and operational rules`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Rule`}),_jsx(_components.th,{children:`Current behavior`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Merchant must be verified/published`}),_jsx(_components.td,{children:`Required for create, update, delete`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`URL must be valid`}),_jsx(_components.td,{children:`Enforced`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Duplicate URL for same merchant`}),_jsx(_components.td,{children:`Rejected`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Wrong merchant tries to access webhook`}),_jsx(_components.td,{children:`Returns not found`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`recommended-operational-model`,children:`Recommended operational model`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`one primary webhook URL per environment`}),`\n`,_jsx(_components.li,{children:`optionally one additional audit or dead-letter endpoint`}),`\n`,_jsx(_components.li,{children:`avoid pointing the same merchant to too many downstream consumers unless you truly need fan-out`}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`dashboard-vs-api`,children:`Dashboard vs API`}),`\n`,_jsx(_components.p,{children:`You can manage webhooks through the Business dashboard or the API. The API is recommended if you want repeatable environment setup through scripts.`}),`\n`,_jsxs(_components.p,{children:[`See `,_jsx(_components.a,{href:`/webhooks/overview#register-a-webhook`,children:`Webhooks overview`}),` for the quickstart example and `,_jsx(_components.a,{href:`/api-reference`,children:`API reference`}),` for schema details.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Webhook Management","description":"Create, list, update, and delete webhook endpoints","href":"/webhooks/management"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Create","slug":"create","depth":2,"children":[]},{"title":"List","slug":"list","depth":2,"children":[]},{"title":"Retrieve one webhook","slug":"retrieve-one-webhook","depth":2,"children":[]},{"title":"Update","slug":"update","depth":2,"children":[]},{"title":"Delete","slug":"delete","depth":2,"children":[]},{"title":"Validation and operational rules","slug":"validation-and-operational-rules","depth":2,"children":[]},{"title":"Recommended operational model","slug":"recommended-operational-model","depth":2,"children":[]},{"title":"Dashboard vs API","slug":"dashboard-vs-api","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"pointsapp","siteName":"Points","title":"Points API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-20T14:09:14.345Z","originalFileLocation":"webhooks/management.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, list, update, and delete webhook endpoints\">\u003cmeta data-mint-head name=\"application-name\" content=\"Points\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/pointsapp/RkvA-tD14RTISszp/_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/pointsapp/RkvA-tD14RTISszp/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pointsapp/RkvA-tD14RTISszp/_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/pointsapp/RkvA-tD14RTISszp/_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/pointsapp/RkvA-tD14RTISszp/_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/pointsapp/RkvA-tD14RTISszp/_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/pointsapp/RkvA-tD14RTISszp/_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/pointsapp/RkvA-tD14RTISszp/_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/pointsapp/RkvA-tD14RTISszp/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Points API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Official developer documentation for the Points API — Saudi Arabia\u0026#x27;s unified loyalty rewards platform.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Points\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.papp.sa/webhooks/management\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://pointsapp.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Webhook+Management\u0026amp;description=Create%2C+list%2C+update%2C+and+delete+webhook+endpoints\u0026amp;theme=b531fb4ad67e809661365670\u0026amp;signature=ddf1a3883f64198ab2e067e5bae33588b1c2963d1f16ff43159a1ac1388de109\">\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=\"Points API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Official developer documentation for the Points API — Saudi Arabia\u0026#x27;s unified loyalty rewards platform.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://pointsapp.mintlify.site/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Webhook+Management\u0026amp;description=Create%2C+list%2C+update%2C+and+delete+webhook+endpoints\u0026amp;theme=b531fb4ad67e809661365670\u0026amp;signature=ddf1a3883f64198ab2e067e5bae33588b1c2963d1f16ff43159a1ac1388de109\">\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/pointsapp/RkvA-tD14RTISszp/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Points\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"application-name\" content=\"Points\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.papp.sa/webhooks/management\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/webhooks/management.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.papp.sa/#organization\",\"name\":\"Points\",\"url\":\"https://docs.papp.sa\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/pointsapp/d74aWCsg391wAlk5/logo/points-logo-color.png?fit=max\u0026auto=format\u0026n=d74aWCsg391wAlk5\u0026q=85\u0026s=948090094e80ad893bd7f2ba254ca31c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.papp.sa#website\",\"name\":\"Points\",\"url\":\"https://docs.papp.sa\",\"publisher\":{\"@id\":\"https://docs.papp.sa/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.papp.sa/webhooks/management#webpage\",\"url\":\"https://docs.papp.sa/webhooks/management\",\"name\":\"Webhook Management\",\"description\":\"Create, list, update, and delete webhook endpoints\",\"dateModified\":\"2026-04-20T14:09:14.345Z\",\"isPartOf\":{\"@id\":\"https://docs.papp.sa#website\"},\"breadcrumb\":{\"@id\":\"https://docs.papp.sa/webhooks/management#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.papp.sa/webhooks/management#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Webhooks\",\"item\":\"https://docs.papp.sa/webhooks/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Webhook Management\",\"item\":\"https://docs.papp.sa/webhooks/management\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.papp.sa/webhooks/management#article\",\"headline\":\"Webhook Management\",\"name\":\"Webhook Management\",\"description\":\"Create, list, update, and delete webhook endpoints\",\"url\":\"https://docs.papp.sa/webhooks/management\",\"mainEntityOfPage\":{\"@id\":\"https://docs.papp.sa/webhooks/management#webpage\"},\"dateModified\":\"2026-04-20T14:09:14.345Z\",\"publisher\":{\"@id\":\"https://docs.papp.sa/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.papp.sa#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Points\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Points\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/webhooks/management.md","siteName":"Points","nav":{"global":null,"tabs":[{"tab":"Documentation","groups":[{"group":"Introduction","pages":[{"title":"What is Points ?","href":"/introduction/what-is-points"},{"title":"Technical Requirements","href":"/introduction/technical-requirements"},{"title":"F.A.Q.","href":"/introduction/faq"},{"title":"Quick start","href":"/introduction/quickstart"}]},{"group":"E-commerce Platforms","pages":[{"title":"Salla","href":"/e-commerce-platforms/salla"},{"title":"Matajer","href":"/e-commerce-platforms/matajer"}]},{"group":"Authentication","pages":[{"title":"API Keys","href":"/authentication/api-keys"},{"title":"IP Whitelisting","href":"/authentication/ip-whitelisting"},{"title":"Security Best Practices","href":"/authentication/security"}]},{"group":"Integration Guide","pages":[{"title":"Checkout Flow","href":"/integration/checkout-flow"},{"title":"Earning Methods","href":"/integration/earning-methods"},{"title":"Order Lifecycle \u0026 Statuses","href":"/integration/order-lifecycle"},{"title":"Refunds \u0026 Cancellations","href":"/integration/refunds-cancellations"}]},{"group":"Webhooks","pages":[{"title":"Webhooks Overview","href":"/webhooks/overview"},{"title":"Webhook Events","description":"Full catalogue of events Points delivers to your webhook endpoints","href":"/webhooks/events"},{"title":"Webhook Management","href":"/webhooks/management"}]},{"group":"Widgets","pages":[{"title":"Widgets","description":"Embed Points promotional messaging on product and checkout pages","href":"/widgets/overview"},{"title":"Widget Playground","href":"/widgets/widget-playground"}]},{"group":"SDKs","pages":[{"title":"PHP SDK","href":"/sdk/php-sdk"}]},{"group":"Testing","pages":[{"title":"Testing Credentials","href":"/testing/credentials"},{"title":"Go-Live Checklist","href":"/testing/go-live-checklist"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/orders/begin-checkout-for-a-replacing-order"}]}]},"basePath":"","title":"Points API Documentation","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":[],"chunks":[]}