Returns the JSON body and event name used for manual test deliveries (webhook.test).
The sentAt field in the sample is refreshed when POST /webhooks/test actually sends.
How to call — GET{server}/api/v1/business/webhooks/test-sample with X-API-Key.
GET
/
api
/
v1
/
business
/
webhooks
/
test-sample
Test delivery sample
curl --request GET \
--url https://api-stage.ugift.me/api/v1/business/webhooks/test-sample \
--header 'X-API-Key: <api-key>'
{
"event": "webhook.test",
"payload": {
"type": "webhook.test",
"sentAt": "2025-04-11T08:15:00.000Z",
"data": {
"message": "This is a test delivery from UGiftMe. Your endpoint should return HTTP 2xx within 10 seconds.",
"exampleOrderId": "ord_example_123"
}
}
}
{
"type": "webhook.test",
"sentAt": "2025-04-11T08:15:00.000Z",
"data": {
"message": "This is a test delivery from UGiftMe. Your endpoint should return HTTP 2xx within 10 seconds.",
"exampleOrderId": "ord_example_123"
}
}
⌘I
Test delivery sample
curl --request GET \
--url https://api-stage.ugift.me/api/v1/business/webhooks/test-sample \
--header 'X-API-Key: <api-key>'
{
"event": "webhook.test",
"payload": {
"type": "webhook.test",
"sentAt": "2025-04-11T08:15:00.000Z",
"data": {
"message": "This is a test delivery from UGiftMe. Your endpoint should return HTTP 2xx within 10 seconds.",
"exampleOrderId": "ord_example_123"
}
}
}
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/schema.json","name":"UGiftMe Multi-Platform Integration Hub API","colors":{"primary":"#F97316","light":"#FB923C","dark":"#EA580C"},"logo":{"light":"https://mintcdn.com/ugiftme-c0b4beea/2tCyDZ0Ixofjq9xJ/logo/ugm-logo.png?fit=max\u0026auto=format\u0026n=2tCyDZ0Ixofjq9xJ\u0026q=85\u0026s=f2d2882b102f0e0c5c64c0d32e6e2ec9","dark":"https://mintcdn.com/ugiftme-c0b4beea/2tCyDZ0Ixofjq9xJ/logo/ugm-logo.png?fit=max\u0026auto=format\u0026n=2tCyDZ0Ixofjq9xJ\u0026q=85\u0026s=f2d2882b102f0e0c5c64c0d32e6e2ec9"},"favicon":"https://mintcdn.com/ugiftme-c0b4beea/2tCyDZ0Ixofjq9xJ/logo/image.png?fit=max\u0026auto=format\u0026n=2tCyDZ0Ixofjq9xJ\u0026q=85\u0026s=48b64cd1dc451777220d5450b0466feb","api":{"playground":{"display":"interactive"}},"fonts":{"heading":{"family":"Marr Sans Cond Web Bold Regular","source":"fonts/marr-sans.woff2","format":"woff2"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ugiftme-c0b4beea","hasAudioNarration":false,"actualSubdomain":"ugiftme-c0b4beea","customDomains":["docs.ugift.me"],"gitSource":{"type":"github","owner":"gift-alliance","repo":"zapier-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e7908d1fcd719df05a0c","collectionId":"85f7bcc8-8057-435a-b21a-08ca797c0b4b","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21e7908d1fcd719df05a0c:success","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API Reference","count":26},{"language":"default","tag":"Outbound webhook events","count":26},{"language":"default","tag":"Outbound Webhooks","count":7},{"language":"default","tag":"Orders \u0026 Dispatch","count":6},{"language":"default","tag":"Webhooks","count":6},{"language":"default","tag":"Financials","count":3},{"language":"default","tag":"Product Catalog","count":3},{"language":"default","tag":"API Guide","count":2},{"language":"default","tag":"API Overview","count":1},{"language":"default","tag":"Authentication","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/webhooks/test-delivery-sample","slug":"/api-reference/webhooks/test-delivery-sample","pageMetadata":{"title":"Test delivery sample","description":"Returns the JSON body and event name used for manual test deliveries (`webhook.test`).\nThe `sentAt` field in the sample is refreshed when **`POST /webhooks/test`** actually sends.\n\n**How to call** — **GET** `{server}/api/v1/business/webhooks/test-sample` with `X-API-Key`.\n","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/webhooks/test-sample","href":"/api-reference/webhooks/test-delivery-sample","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Returns the JSON body and event name used for manual test deliveries (\", _jsx(_components.code, {\n children: \"webhook.test\"\n }), \").\\nThe \", _jsx(_components.code, {\n children: \"sentAt\"\n }), \" field in the sample is refreshed when \", _jsx(_components.strong, {\n children: _jsx(_components.code, {\n children: \"POST /webhooks/test\"\n })\n }), \" actually sends.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"How to call\"\n }), \" — \", _jsx(_components.strong, {\n children: \"GET\"\n }), \" \", _jsx(_components.code, {\n children: \"{server}/api/v1/business/webhooks/test-sample\"\n }), \" with \", _jsx(_components.code, {\n children: \"X-API-Key\"\n }), \".\"]\n })]\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":"Test delivery sample","description":"Returns the JSON body and event name used for manual test deliveries (`webhook.test`).\nThe `sentAt` field in the sample is refreshed when **`POST /webhooks/test`** actually sends.\n\n**How to call** — **GET** `{server}/api/v1/business/webhooks/test-sample` with `X-API-Key`.\n","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/webhooks/test-sample","href":"/api-reference/webhooks/test-delivery-sample","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getWebhookTestSample","tags":["Webhooks"],"summary":"Test delivery sample","description":"Returns the JSON body and event name used for manual test deliveries (`webhook.test`).\nThe `sentAt` field in the sample is refreshed when **`POST /webhooks/test`** actually sends.\n\n**How to call** — **GET** `{server}/api/v1/business/webhooks/test-sample` with `X-API-Key`.\n","responses":{"200":"87ed4e6f-a2d4-42f6-8ad5-5ca2a094e4ba","401":"c34a2c1a-1d7c-4572-86d4-cc85b807b54f","403":"f7985403-b614-4957-815a-7836239d0363","429":"606a9c1d-4195-460f-b045-404ac68332f3","500":"30ec3bf7-ef3d-44de-ac13-ef70a2224755"},"method":"get","type":"path","servers":["652919f1-ece8-4515-836e-66e5297f00c9","e0929d81-db8d-4e5d-a366-72d1a47acfe5"],"security":["04627765-201f-4db5-901d-45a374f6f94e"],"path":"/api/v1/business/webhooks/test-sample","baseUrlOptions":["https://api-stage.ugift.me","https://api.ugift.me"],"title":"Test delivery sample","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"87ed4e6f-a2d4-42f6-8ad5-5ca2a094e4ba":{"description":"Sample test event","content":{"application/json":{"schema":{"type":"object","required":["event","payload"],"properties":{"event":{"type":"string","example":"webhook.test","isRequired":true,"uniqueKey":"event","typeLabel":"string"},"payload":{"type":"object","required":["type","sentAt","data"],"properties":{"type":{"type":"string","example":"webhook.test","isRequired":true,"uniqueKey":"payload.type","typeLabel":"string"},"sentAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"payload.sentAt","typeLabel":"string\u003cdate-time>"},"data":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"payload.data.message","typeLabel":"string"},"exampleOrderId":{"type":"string","uniqueKey":"payload.data.exampleOrderId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"payload.data","typeLabel":"object"}},"example":{"type":"webhook.test","sentAt":"2025-04-11T08:15:00.000Z","data":{"message":"This is a test delivery from UGiftMe. Your endpoint should return HTTP 2xx within 10 seconds.","exampleOrderId":"ord_example_123"}},"isRequired":true,"uniqueKey":"payload","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"event":"webhook.test","payload":{"type":"webhook.test","sentAt":"2025-04-11T08:15:00.000Z","data":{"message":"This is a test delivery from UGiftMe. Your endpoint should return HTTP 2xx within 10 seconds.","exampleOrderId":"ord_example_123"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"c34a2c1a-1d7c-4572-86d4-cc85b807b54f":{"description":"Authentication failed — missing, invalid, or (for some routes) unresolvable API key context.\n","content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"Missing or invalid `X-API-Key`.","required":["error"],"properties":{"error":{"type":"string","example":"Missing API key","isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"string"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","description":"Missing or invalid `X-API-Key`.","required":["error"],"properties":{"error":{"type":"string","example":"Invalid API key","isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"string"},"reason":{"type":"string","description":"Why the key failed validation (when available)","example":"Key has been revoked","uniqueKey":"oneOf.1.reason","typeLabel":"string"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"missingApiKey":{"title":"missingApiKey","value":{"error":"Missing API key"}},"invalidApiKey":{"title":"invalidApiKey","value":{"error":"Invalid API key","reason":"Key has been revoked"}}},"exampleType":"examples"}},"exampleType":"examples"},"f7985403-b614-4957-815a-7836239d0363":{"description":"Access denied (HTTP 403). Common causes: caller IP not on the key allow list, business profile incomplete\nor unverified on GET /auth, or the authenticated account cannot access the resource\n(e.g. another account's webhook).\n","content":{"application/json":{"schema":{"type":"object","description":"Access denied — IP not on the key allow list, incomplete/unverified business profile on GET /auth,\nor insufficient permission to the resource (e.g. webhook owned by another account).\n","required":["error"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"ip":{"type":"string","description":"Caller IP when blocked by the key allow list","uniqueKey":"ip","typeLabel":"string"},"whitelistedIps":{"type":"array","items":{"type":"string","uniqueKey":"whitelistedIps.items.[INDEX]","typeLabel":"string"},"uniqueKey":"whitelistedIps","typeLabel":"string[]"},"status":{"type":"string","description":"Business verification or profile status (`GET /auth`)","uniqueKey":"status","typeLabel":"string"},"missingFields":{"type":"array","items":{"type":"string","uniqueKey":"missingFields.items.[INDEX]","typeLabel":"string"},"uniqueKey":"missingFields","typeLabel":"string[]"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"","typeLabel":"object"},"example":{"error":"IP not whitelisted","ip":"203.0.113.10","whitelistedIps":["198.51.100.0/24"]},"examples":{"ipNotWhitelisted":{"title":"ipNotWhitelisted","value":{"error":"IP not whitelisted","ip":"203.0.113.10","whitelistedIps":["198.51.100.0/24"]}},"incompleteBusinessProfile":{"title":"incompleteBusinessProfile","value":{"error":"Incomplete business profile","status":"incomplete","missingFields":["businessPhoneNumber","registrationNumber"]}},"businessNotVerified":{"title":"businessNotVerified","value":{"error":"Business verification pending","status":"pending","message":"Complete business verification process"}},"webhookAccessDenied":{"title":"webhookAccessDenied","value":{"error":"You are forbidden from accessing this resource"}}},"exampleType":"examples"}},"exampleType":"examples"},"606a9c1d-4195-460f-b045-404ac68332f3":{"description":"Rate limit exceeded for the route's limiter. Response body is `{ \"error\": \"\u003cmessage>\" }`.\nStandard rate-limit headers are included when the limiter supports them.\n","headers":{"retry-after":{"description":"Seconds to wait before retrying","schema":{"type":"integer","example":60}},"RateLimit-Limit":{"description":"Maximum requests allowed in the window","schema":{"type":"integer","example":100}},"RateLimit-Remaining":{"description":"Remaining requests in the current window","schema":{"type":"integer","example":0}},"RateLimit-Reset":{"description":"Unix timestamp when the window resets","schema":{"type":"integer","example":1713187200}}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Rate-limit message depends on the route limiter (products, webhooks, wallet, etc.).\n","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"example":{"error":"Too many product access attempts, please try again later."},"uniqueKey":"","typeLabel":"object"},"examples":{"productCatalog":{"title":"productCatalog","value":{"error":"Too many product access attempts, please try again later."}},"webhooks":{"title":"webhooks","value":{"error":"Too many webhook configuration attempts, please try again later."}},"wallet":{"title":"wallet","value":{"error":"Too many sensitive operations, please try again later."}}},"exampleType":"examples"}},"exampleType":"examples"},"30ec3bf7-ef3d-44de-ac13-ef70a2224755":{"description":"Unexpected server error. Usually `{ \"error\": \"An error occurred\" }` from the business router,\nor a route-specific failure message with optional `message` / `details`.\n","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Route-specific failure summary","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Additional detail (common on webhook and wallet routes)","uniqueKey":"message","typeLabel":"string"},"details":{"type":"string","description":"Additional detail (used on some product catalog routes)","uniqueKey":"details","typeLabel":"string"}},"example":{"error":"An error occurred","message":"Optional server detail"},"uniqueKey":"","typeLabel":"object"},"examples":{"generic":{"title":"generic","value":{"error":"An error occurred","message":"An error occurred"}},"products":{"title":"products","value":{"error":"Failed to fetch one or more products","message":"Connection timeout"}},"productFilters":{"title":"productFilters","value":{"error":"Failed to fetch filters","details":"Connection timeout"}},"webhooks":{"title":"webhooks","value":{"error":"Failed to register webhook","message":"Database error"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"04627765-201f-4db5-901d-45a374f6f94e":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Your UGiftMe API key for authentication.\n\n**Format**: Secure API key (e.g., `\u003cyour-api-key>`)\n\n**Required**: All endpoints require this header\n\nExample: `X-API-Key: \u003cyour-api-key>`\n","scopes":[]}}},"servers":{"652919f1-ece8-4515-836e-66e5297f00c9":{"url":"https://api-stage.ugift.me","description":"Sandbox"},"e0929d81-db8d-4e5d-a366-72d1a47acfe5":{"url":"https://api.ugift.me","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Your UGiftMe API key for authentication.\n\n**Format**: Secure API key (e.g., `\u003cyour-api-key>`)\n\n**Required**: All endpoints require this header\n\nExample: `X-API-Key: \u003cyour-api-key>`\n","scopes":[]},"schema":{"title":"X-API-Key","type":"string","description":"Your UGiftMe API key for authentication.\n\n**Format**: Secure API key (e.g., `\u003cyour-api-key>`)\n\n**Required**: All endpoints require this header\n\nExample: `X-API-Key: \u003cyour-api-key>`\n","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi-business.yaml"},"subdomain":"ugiftme-c0b4beea","siteName":"UGiftMe Multi-Platform Integration Hub API","title":"Test delivery sample - UGiftMe Multi-Platform Integration Hub API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-24T00:20:27.163Z","originalFileLocation":"api-reference/webhooks/test-delivery-sample.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=\"Returns the JSON body and event name used for manual test deliveries (webhook.test). The sentAt field in the sample is refreshed when POST /webhooks/test actually sends. How to call — GET {server}/api/v1/business/webhooks/test-sample with X-API-Key.\">\u003cmeta data-mint-head name=\"application-name\" content=\"UGiftMe Multi-Platform Integration Hub API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ugiftme-c0b4beea/QmyuTlHWbXqKjnjo/_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/ugiftme-c0b4beea/QmyuTlHWbXqKjnjo/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ugiftme-c0b4beea/QmyuTlHWbXqKjnjo/_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/ugiftme-c0b4beea/QmyuTlHWbXqKjnjo/_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/ugiftme-c0b4beea/QmyuTlHWbXqKjnjo/_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/ugiftme-c0b4beea/QmyuTlHWbXqKjnjo/_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/ugiftme-c0b4beea/QmyuTlHWbXqKjnjo/_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/ugiftme-c0b4beea/QmyuTlHWbXqKjnjo/_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/ugiftme-c0b4beea/QmyuTlHWbXqKjnjo/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Test delivery sample - UGiftMe Multi-Platform Integration Hub API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the JSON body and event name used for manual test deliveries (webhook.test). The sentAt field in the sample is refreshed when POST /webhooks/test actually sends. How to call — GET {server}/api/v1/business/webhooks/test-sample with X-API-Key.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"UGiftMe Multi-Platform Integration Hub API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ugift.me/api-reference/webhooks/test-delivery-sample\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ugiftme-c0b4beea.mintlify.app/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Test+delivery+sample\u0026amp;description=Returns+the+JSON+body+and+event+name+used+for+manual+test+deliveries+%28%60webhook.test%60%29.%0AThe+%60sentAt%60+field+in+the+sample+is+refreshed+when+**%60POST+%2Fwebhooks%2Ftest\u0026amp;theme=553f64741f4e6ad060709561\u0026amp;signature=dd9a4bad1f3033b9f748960e1f4df2fd7337f6074aaf08b20a46dde5c9bca95f\">\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=\"Test delivery sample - UGiftMe Multi-Platform Integration Hub API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the JSON body and event name used for manual test deliveries (webhook.test). The sentAt field in the sample is refreshed when POST /webhooks/test actually sends. How to call — GET {server}/api/v1/business/webhooks/test-sample with X-API-Key.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ugiftme-c0b4beea.mintlify.app/_mintlify/api/og/v2?division=Webhooks\u0026amp;title=Test+delivery+sample\u0026amp;description=Returns+the+JSON+body+and+event+name+used+for+manual+test+deliveries+%28%60webhook.test%60%29.%0AThe+%60sentAt%60+field+in+the+sample+is+refreshed+when+**%60POST+%2Fwebhooks%2Ftest\u0026amp;theme=553f64741f4e6ad060709561\u0026amp;signature=dd9a4bad1f3033b9f748960e1f4df2fd7337f6074aaf08b20a46dde5c9bca95f\">\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/ugiftme-c0b4beea/QmyuTlHWbXqKjnjo/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"UGiftMe Multi-Platform Integration Hub API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#F97316\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.ugift.me/api-reference/webhooks/test-delivery-sample\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/webhooks/test-delivery-sample.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.ugift.me/#organization\",\"name\":\"UGiftMe Multi-Platform Integration Hub API\",\"url\":\"https://docs.ugift.me\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ugiftme-c0b4beea/2tCyDZ0Ixofjq9xJ/logo/ugm-logo.png?fit=max\u0026auto=format\u0026n=2tCyDZ0Ixofjq9xJ\u0026q=85\u0026s=f2d2882b102f0e0c5c64c0d32e6e2ec9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.ugift.me#website\",\"name\":\"UGiftMe Multi-Platform Integration Hub API\",\"url\":\"https://docs.ugift.me\",\"publisher\":{\"@id\":\"https://docs.ugift.me/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.ugift.me/api-reference/webhooks/test-delivery-sample#webpage\",\"url\":\"https://docs.ugift.me/api-reference/webhooks/test-delivery-sample\",\"name\":\"Test delivery sample\",\"description\":\"Returns the JSON body and event name used for manual test deliveries (webhook.test). The sentAt field in the sample is refreshed when POST /webhooks/test actually sends. How to call — GET {server}/api/v1/business/webhooks/test-sample with X-API-Key.\",\"dateModified\":\"2026-05-24T00:20:27.163Z\",\"isPartOf\":{\"@id\":\"https://docs.ugift.me#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ugift.me/api-reference/webhooks/test-delivery-sample#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ugift.me/api-reference/webhooks/test-delivery-sample#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Webhooks\",\"item\":\"https://docs.ugift.me/api-reference/webhooks/create-webhook\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Test delivery sample\",\"item\":\"https://docs.ugift.me/api-reference/webhooks/test-delivery-sample\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.ugift.me/api-reference/webhooks/test-delivery-sample#apireference\",\"headline\":\"Test delivery sample\",\"name\":\"Test delivery sample\",\"description\":\"Returns the JSON body and event name used for manual test deliveries (webhook.test). The sentAt field in the sample is refreshed when POST /webhooks/test actually sends. How to call — GET {server}/api/v1/business/webhooks/test-sample with X-API-Key.\",\"url\":\"https://docs.ugift.me/api-reference/webhooks/test-delivery-sample\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ugift.me/api-reference/webhooks/test-delivery-sample#webpage\"},\"dateModified\":\"2026-05-24T00:20:27.163Z\",\"publisher\":{\"@id\":\"https://docs.ugift.me/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.ugift.me#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"UGiftMe Multi-Platform Integration Hub API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"UGiftMe Multi-Platform Integration Hub API","nav":{"global":null,"tabs":[{"tab":"API Overview","pages":[{"title":"API Overview","href":"/docs/api-overview"}]},{"tab":"API Guide","pages":[{"title":"API Guide","href":"/docs/business-api"}]},{"tab":"API Reference","groups":[{"group":"Authentication","pages":[{"title":"Verify Credentials","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/auth","href":"/api-reference/authentication/verify-credentials"}]},{"group":"Product Catalog","pages":[{"title":"Browse Catalog","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/products","href":"/api-reference/product-catalog/browse-catalog"},{"title":"Catalog Filters","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/products/filters","href":"/api-reference/product-catalog/catalog-filters"},{"title":"Search Products","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/products/search","href":"/api-reference/product-catalog/search-products"}]},{"group":"Orders \u0026 Dispatch","pages":[{"title":"Create New Order","deprecated":null,"version":null,"openapi":"/openapi-business.yaml post /api/v1/business/orders","href":"/api-reference/orders-\u0026-dispatch/create-new-order"},{"title":"Bulk Order","deprecated":null,"version":null,"openapi":"/openapi-business.yaml post /api/v1/business/orders/bulk","href":"/api-reference/orders-\u0026-dispatch/bulk-order"},{"title":"Order History","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/orders","href":"/api-reference/orders-\u0026-dispatch/order-history"},{"title":"Order Details","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/orders/{orderId}","href":"/api-reference/orders-\u0026-dispatch/order-details"},{"title":"Queue Status","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/orders/order-requests/{id}","href":"/api-reference/orders-\u0026-dispatch/queue-status"},{"title":"Advanced Search","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/orders/search","href":"/api-reference/orders-\u0026-dispatch/advanced-search"}]},{"group":"Financials","pages":[{"title":"Wallet","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/wallet","href":"/api-reference/financials/wallet"},{"title":"View Balances","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/wallet/balance","href":"/api-reference/financials/view-balances"},{"title":"Transaction Ledger","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/wallet/transactions","href":"/api-reference/financials/transaction-ledger"}]},{"group":"Webhooks","pages":[{"title":"Create Webhook","deprecated":null,"version":null,"openapi":"/openapi-business.yaml post /api/v1/business/webhooks","href":"/api-reference/webhooks/create-webhook"},{"title":"Update Webhook","deprecated":null,"version":null,"openapi":"/openapi-business.yaml patch /api/v1/business/webhooks/{id}","href":"/api-reference/webhooks/update-webhook"},{"title":"Active Subscriptions","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/webhooks","href":"/api-reference/webhooks/active-subscriptions"},{"title":"Remove Webhook","description":"Deletes a webhook configuration by id.\n\n**How to call** — **DELETE** `{server}/api/v1/business/webhooks/{id}` with `X-API-Key`.\n","deprecated":null,"version":null,"openapi":"/openapi-business.yaml delete /api/v1/business/webhooks/{id}","href":"/api-reference/webhooks/remove-webhook"},{"title":"Test delivery sample","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/webhooks/test-sample","href":"/api-reference/webhooks/test-delivery-sample"},{"title":"Send test delivery","description":"POSTs a signed **`webhook.test`** payload to a saved subscription URL. Does not create delivery\naudit rows. Uses a **10 s** timeout and sets header **`X-Webhook-Delivery: test`**.\n\n**How to call** — **POST** `{server}/api/v1/business/webhooks/test` with `X-API-Key` and body `{ \"webhookId\": \"\u003cid>\" }`.\n","deprecated":null,"version":null,"openapi":"/openapi-business.yaml post /api/v1/business/webhooks/test","href":"/api-reference/webhooks/send-test-delivery"}]},{"group":"Outbound webhook events","pages":[{"title":"OrderQueued","href":"/orderQueued"},{"title":"OrderProcessing","href":"/orderProcessing"},{"title":"OrderSucceeded","href":"/orderSucceeded"},{"title":"OrderFailed","href":"/orderFailed"},{"title":"WalletUpdated","href":"/walletUpdated"},{"title":"ProductUpdated","href":"/productUpdated"},{"title":"WebhookTest","href":"/webhookTest"},{"group":"Authentication","pages":[{"title":"Verify Credentials","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/auth","href":"/api-reference/authentication/verify-credentials"}]},{"group":"Product Catalog","pages":[{"title":"Browse Catalog","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/products","href":"/api-reference/product-catalog/browse-catalog"},{"title":"Catalog Filters","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/products/filters","href":"/api-reference/product-catalog/catalog-filters"},{"title":"Search Products","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/products/search","href":"/api-reference/product-catalog/search-products"}]},{"group":"Orders \u0026 Dispatch","pages":[{"title":"Order History","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/orders","href":"/api-reference/orders-\u0026-dispatch/order-history"},{"title":"Create New Order","deprecated":null,"version":null,"openapi":"/openapi-business.yaml post /api/v1/business/orders","href":"/api-reference/orders-\u0026-dispatch/create-new-order"},{"title":"Advanced Search","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/orders/search","href":"/api-reference/orders-\u0026-dispatch/advanced-search"},{"title":"Bulk Order","deprecated":null,"version":null,"openapi":"/openapi-business.yaml post /api/v1/business/orders/bulk","href":"/api-reference/orders-\u0026-dispatch/bulk-order"},{"title":"Queue Status","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/orders/order-requests/{id}","href":"/api-reference/orders-\u0026-dispatch/queue-status"},{"title":"Order Details","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/orders/{orderId}","href":"/api-reference/orders-\u0026-dispatch/order-details"}]},{"group":"Financials","pages":[{"title":"Wallet","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/wallet","href":"/api-reference/financials/wallet"},{"title":"View Balances","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/wallet/balance","href":"/api-reference/financials/view-balances"},{"title":"Transaction Ledger","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/wallet/transactions","href":"/api-reference/financials/transaction-ledger"}]},{"group":"Webhooks","pages":[{"title":"Active Subscriptions","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/webhooks","href":"/api-reference/webhooks/active-subscriptions"},{"title":"Create Webhook","deprecated":null,"version":null,"openapi":"/openapi-business.yaml post /api/v1/business/webhooks","href":"/api-reference/webhooks/create-webhook"},{"title":"Remove Webhook","deprecated":null,"version":null,"openapi":"/openapi-business.yaml delete /api/v1/business/webhooks/{id}","href":"/api-reference/webhooks/remove-webhook"},{"title":"Update Webhook","description":"Updates an existing webhook **subscription** (configuration stored in UGiftMe).\n\nThis does **not** change how you receive deliveries: UGiftMe still **POSTs** event payloads to your URL.\nUse PATCH to change the target URL, subscribed events, description, or pause/resume (`isActive`) **without** deleting and\nre-creating the webhook (the signing **secret** is unchanged).\n\nProvide **at least one** of `url`, `events`, `description`, `isActive`. When updating `events`, the array must be\nnon-empty and only contain allowed event types.\n\n**How to call** — **PATCH** `{server}/api/v1/business/webhooks/{id}` with `X-API-Key` and a JSON body.\n","deprecated":null,"version":null,"openapi":"/openapi-business.yaml patch /api/v1/business/webhooks/{id}","href":"/api-reference/webhooks/update-webhook"},{"title":"Test delivery sample","deprecated":null,"version":null,"openapi":"/openapi-business.yaml get /api/v1/business/webhooks/test-sample","href":"/api-reference/webhooks/test-delivery-sample"},{"title":"Send test delivery","description":"POSTs a signed **`webhook.test`** payload to a saved subscription URL. Does not create delivery\naudit rows. Uses a **10 s** timeout and sets header **`X-Webhook-Delivery: test`**.\n\n**How to call** — **POST** `{server}/api/v1/business/webhooks/test` with `X-API-Key` and body `{ \"webhookId\": \"\u003cid>\" }`.\n","deprecated":null,"version":null,"openapi":"/openapi-business.yaml post /api/v1/business/webhooks/test","href":"/api-reference/webhooks/send-test-delivery"}]},{"group":"Outbound Webhooks","pages":[{"title":"Orderqueued","version":null,"deprecated":null,"openapi":"/openapi-business.yaml webhook orderQueued","href":"/api-reference/outbound-webhooks/orderqueued"},{"title":"Orderprocessing","version":null,"deprecated":null,"openapi":"/openapi-business.yaml webhook orderProcessing","href":"/api-reference/outbound-webhooks/orderprocessing"},{"title":"Ordersucceeded","version":null,"deprecated":null,"openapi":"/openapi-business.yaml webhook orderSucceeded","href":"/api-reference/outbound-webhooks/ordersucceeded"},{"title":"Orderfailed","version":null,"deprecated":null,"openapi":"/openapi-business.yaml webhook orderFailed","href":"/api-reference/outbound-webhooks/orderfailed"},{"title":"Walletupdated","version":null,"deprecated":null,"openapi":"/openapi-business.yaml webhook walletUpdated","href":"/api-reference/outbound-webhooks/walletupdated"},{"title":"Productupdated","version":null,"deprecated":null,"openapi":"/openapi-business.yaml webhook productUpdated","href":"/api-reference/outbound-webhooks/productupdated"},{"title":"Webhooktest","version":null,"deprecated":null,"openapi":"/openapi-business.yaml webhook webhookTest","href":"/api-reference/outbound-webhooks/webhooktest"}]}]}]}]},"basePath":"","title":"Test delivery sample - UGiftMe Multi-Platform Integration Hub API","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-Bevw23-4.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}