Unique name of the workflow. The workflow name should be easily identifiable for your reference at a later stage. You can see workflow-related analytics on the workflow page (how many notifications were sent, delivered, clicked or interacted).
Unique slug of the template created on SuprSend dashboard. You can get this by clicking on the clipboard icon next to the Template name on SuprSend templates page.
Workflow will be halted for the time mentioned in delay, and become active once the delay period is over. Format - XXdXXhXXmXXs or if its number (n) then delay is in seconds (n)
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"SuprSend: API-first notification infrastructure","colors":{"primary":"#2E70E8","light":"#63A3F7","dark":"#2E70E8"},"logo":"https://mintcdn.com/suprsend/CMaQBA3E8wM1DyFj/images/suprsend-logo.svg?fit=max\u0026auto=format\u0026n=CMaQBA3E8wM1DyFj\u0026q=85\u0026s=f325b9764c629a0b488476db369b8d47","favicon":"https://mintcdn.com/suprsend/5H8hv-jDy8OaCsyX/favicon.svg?fit=max\u0026auto=format\u0026n=5H8hv-jDy8OaCsyX\u0026q=85\u0026s=e9c88c84e18f0fd4a64adb33f5fa3603","api":{"openapi":"openapi.yaml"},"background":{"decoration":"windows"},"navbar":{"links":[{"href":"mailto:support@suprsend.com","label":"Contact Us"}],"primary":{"type":"button","label":"Get Started","href":"https://app.suprsend.com"}},"footer":{"socials":{"x":"https://x.com/suprsend","github":"https://github.com/suprsend","linkedin":"https://linkedin.com/company/suprsend","youtube":"https://youtube.com/@suprsend"}},"seo":{"indexing":"all"},"fonts":{"family":"Inter"},"styling":{"codeblocks":"system","latex":true},"integrations":{"ga4":{"measurementId":"G-PPDYBESP2L"},"gtm":{"tagId":"GTM-T6W3P8RG"},"mixpanel":{"projectToken":"2febb9e078d777860c5624f2579507a7"}},"contextual":{"options":["chatgpt","claude"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"slack","color":{"light":"#f59f0b","dark":"#f59f0b"},"href":"https://join.slack.com/t/suprsendcommunity/shared_invite/zt-3932rw936-XNWY1RC8bsffh4if4ZyoXQ"},{"anchor":"Trust Center","icon":"shield-halved","color":{"light":"#2564eb","dark":"#2564eb"},"href":"https://trust.suprsend.com"},{"anchor":"Platform Status","icon":"wifi","color":{"light":"#2564eb","dark":"#2564eb"},"href":"https://status.suprsend.com"},{"anchor":"Postman Collection","icon":"code","color":{"light":"#2564eb","dark":"#2564eb"},"href":"https://www.postman.com/suprsend/suprsend/collection/16bdmwa/suprsend-apis"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"suprsend","hasAudioNarration":false,"actualSubdomain":"suprsend","customDomains":["docs.suprsend.com"],"gitSource":{"type":"github","owner":"suprsend","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adfef2d9b97c43b46838a89","collectionId":"3befe8a0-023d-42de-9c6e-90cfba508720","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adfef2d9b97c43b46838a89"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adfef2d9b97c43b46838a89","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"Documentation","count":151},{"language":"default","tag":"Developer Resources","count":105},{"language":"default","tag":"Management API","count":91},{"language":"default","tag":"API Reference","count":86},{"language":"default","tag":"SDKs and APIs","count":81},{"language":"default","tag":"SDKs","count":78},{"language":"default","tag":"CORE CONCEPTS","count":57},{"language":"default","tag":"CLI","count":49},{"language":"default","tag":"SuprSend Client SDK","count":43},{"language":"default","tag":"SuprSend Backend SDK","count":34}]},"assistantConfig":{"deflection":{"enabled":true,"email":"support@suprsend.com","showHelpButton":true}},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"img{max-width:100%;height:auto}table{display:block}code,pre,table{overflow-x:auto;max-width:100%}@media (max-width:768px){img[width]{width:100%!important;max-width:100%!important;height:auto!important}pre{font-size:13px}}a.card[href=\"https://skills.sh/suprsend/skills\"]{position:relative}a.card[href=\"https://skills.sh/suprsend/skills\"]>img{position:absolute!important;top:1.25rem!important;left:1.5rem!important;width:1.5rem!important;height:1.5rem!important;max-width:1.5rem!important;max-height:1.5rem!important;min-height:1.5rem!important;object-fit:contain!important;z-index:1}a.card[href=\"https://skills.sh/suprsend/skills\"] .px-6.py-5{padding-top:3.25rem!important}a.card[href=\"https://skills.sh/suprsend/skills\"] h2{margin-top:0!important}[data-component-name=mermaid-controls-wrapper]{display:none!important}.mermaid .cluster-label,.mermaid .cluster-label p,.mermaid .edgeLabel,.mermaid .edgeLabel p,.mermaid .nodeLabel,.mermaid .nodeLabel p{color:#4d4d4d!important}.mermaid .cluster-label,.mermaid .edgeLabel,.mermaid .nodeLabel,.mermaid text{fill:#4d4d4d!important}.dark .mermaid .cluster-label,.dark .mermaid .cluster-label p,.dark .mermaid .edgeLabel,.dark .mermaid .edgeLabel p,.dark .mermaid .nodeLabel,.dark .mermaid .nodeLabel p{color:#ccc!important}.dark .mermaid .cluster-label,.dark .mermaid .edgeLabel,.dark .mermaid .nodeLabel,.dark .mermaid text{fill:#ccc!important}.changelog-page-content{padding:0 7rem}@media (max-width:768px){.changelog-page-content{padding:0 1rem}}.ss-flow{--ss-ink:#1f2937;--ss-muted:#6b7280;--ss-line:#e5e7eb;--ss-accent:#2e70e8;--ss-core-bg:#f5f8fe;--ss-core-line:#d4e2fb;--ss-arrow:#9ca3af;display:grid;grid-template-columns:minmax(0,1fr) 1.5rem minmax(0,2.1fr) 1.5rem minmax(0,1fr);align-items:center;margin:1.75rem 0 2rem;font-size:.875rem;line-height:1.4;color:var(--ss-ink)}.dark .ss-flow{--ss-ink:#e5e7eb;--ss-muted:#9ca3af;--ss-line:rgba(255, 255, 255, 0.12);--ss-accent:#63a3f7;--ss-core-bg:rgba(46, 112, 232, 0.1);--ss-core-line:rgba(99, 163, 247, 0.28);--ss-arrow:#6b7280}.ss-flow .ss-flow__label{margin:0 0 .5rem;font-size:.75rem;font-weight:600;color:var(--ss-muted)}.ss-flow .ss-flow__list{list-style:none;margin:0;padding:.5rem .75rem;border:1px solid var(--ss-line);border-radius:10px;font-size:.8125rem}.ss-flow .ss-flow__list li{margin:0;padding:.3125rem 0}.ss-flow .ss-flow__arrow{position:relative;height:1px;margin:1.25rem .25rem 0 .125rem;background:var(--ss-arrow)}.ss-flow .ss-flow__arrow::after{content:\"\";position:absolute;top:-4px;right:-1px;border-top:4.5px solid transparent;border-bottom:4.5px solid transparent;border-left:6px solid var(--ss-arrow)}.ss-flow .ss-flow__core{overflow:hidden;border:1px solid var(--ss-core-line);border-radius:14px;background:var(--ss-core-bg)}.ss-flow .ss-flow__label--core{margin:0;padding:.875rem 1rem 0;font-size:.875rem;color:var(--ss-accent)}.ss-flow .ss-flow__stages{list-style:none;margin:0;padding:.875rem 1rem 1rem}.ss-flow .ss-flow__stage{position:relative;margin:0;padding:0 0 1rem 1.5rem}.ss-flow .ss-flow__stage:last-child{padding-bottom:0}.ss-flow .ss-flow__stage::before{content:\"\";position:absolute;top:.3rem;left:0;z-index:1;width:.625rem;height:.625rem;border-radius:50%;background:var(--ss-accent)}.ss-flow .ss-flow__stage::after{content:\"\";position:absolute;top:.5rem;bottom:-.5rem;left:calc(.3125rem - 1px);width:2px;background:var(--ss-core-line)}.ss-flow .ss-flow__stage:last-child::after{display:none}.ss-flow .ss-flow__stage strong{display:block}.ss-flow .ss-flow__stage span{display:block;margin-top:.125rem;font-size:.8125rem;color:var(--ss-muted)}.ss-flow .ss-flow__logs{margin:0;padding:.625rem 1rem;border-top:1px dashed var(--ss-core-line);font-size:.8125rem;color:var(--ss-muted)}.ss-flow .ss-flow__logs strong,.ss-flow .ss-flow__stage strong{font-weight:600;color:var(--ss-ink)}@media (max-width:640px){.ss-flow{grid-template-columns:minmax(0,1fr)}.ss-flow .ss-flow__list{display:flex;flex-wrap:wrap;gap:0 1rem}.ss-flow .ss-flow__arrow{width:1px;height:1.25rem;margin:.5rem auto}.ss-flow .ss-flow__arrow::after{top:auto;right:auto;bottom:-1px;left:-4px;border-top:6px solid var(--ss-arrow);border-right:4.5px solid transparent;border-bottom:0;border-left:4.5px solid transparent}}"}],"page":{"pagePath":"reference/dynamic-workflow-trigger","slug":"/reference/dynamic-workflow-trigger","pageMetadata":{"title":"Dynamic Workflow Trigger","openapi":"POST /{workspace_key}/trigger/","sidebarTitle":"Dynamic Workflow Trigger","description":"API to dynamically create and trigger a single step workflow.","href":"/reference/dynamic-workflow-trigger"},"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: \"API to dynamically create and trigger a single step workflow.\"\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":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Dynamic Workflow Trigger","openapi":"POST /{workspace_key}/trigger/","sidebarTitle":"Dynamic Workflow Trigger","description":"API to dynamically create and trigger a single step workflow.","href":"/reference/dynamic-workflow-trigger"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/suprsend/1ff47b86af33ef76/apollo-tracker.js"],"openApiReferenceData":{"operation":{"summary":"Dynamic Workflow Trigger","security":["eab191cf-4891-4fba-9990-c9cb4217644e"],"description":"API to dynamically create and trigger a single step workflow.","operationId":"dynamic-workflow-trigger","parameters":["2c83c5be-854c-4a20-9630-3d53c062b0db"],"requestBody":"069768a5-1503-4ec8-84e2-e1d1316eaa77","x-codeSamples":[{"lang":"cURL","label":"Dynamic Workflow Trigger","source":"curl -X POST \"https://hub.suprsend.com/{workspace_key}/trigger/\" \\\n --header 'Authorization: Bearer __YOUR_API_KEY__' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"name\": \"Welcome Email Workflow\",\n \"template\": \"welcome-email-template\",\n \"notification_category\": \"transactional\",\n \"users\": [\n {\n \"distinct_id\": \"user123\",\n \"$email\": [\"user@example.com\"],\n \"$channels\": [\"email\"]\n }\n ],\n \"data\": {\n \"user_name\": \"John Doe\",\n \"welcome_message\": \"Welcome to our platform!\"\n }\n }'\n"}],"responses":{"202":"941f8a13-1e54-4132-bc87-4ae9fc3b3bd5","400":"e393cba7-de20-4839-a6af-288cb68d0541"},"deprecated":false,"method":"post","type":"path","servers":["eea7dbe4-4763-43a4-939e-87eba61d4470"],"path":"/{workspace_key}/trigger/","baseUrlOptions":["https://hub.suprsend.com"],"title":"Dynamic Workflow Trigger","codeSamples":[{"label":"Dynamic Workflow Trigger","lang":"cURL","source":"curl -X POST \"https://hub.suprsend.com/{workspace_key}/trigger/\" \\\n --header 'Authorization: Bearer __YOUR_API_KEY__' \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"name\": \"Welcome Email Workflow\",\n \"template\": \"welcome-email-template\",\n \"notification_category\": \"transactional\",\n \"users\": [\n {\n \"distinct_id\": \"user123\",\n \"$email\": [\"user@example.com\"],\n \"$channels\": [\"email\"]\n }\n ],\n \"data\": {\n \"user_name\": \"John Doe\",\n \"welcome_message\": \"Welcome to our platform!\"\n }\n }'\n"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"2c83c5be-854c-4a20-9630-3d53c062b0db":{"name":"workspace_key","in":"path","schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","template","notification_category","users"],"properties":{"name":{"type":"string","description":"Unique name of the workflow. The workflow name should be easily identifiable for your reference at a later stage. You can see workflow-related analytics on the workflow page (how many notifications were sent, delivered, clicked or interacted).","default":"_workflow_name_","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"template":{"type":"string","description":"Unique slug of the template created on SuprSend dashboard. You can get this by clicking on the clipboard icon next to the Template name on SuprSend templates page.","default":"_template_slug_","isRequired":true,"uniqueKey":"template","typeLabel":"string"},"notification_category":{"type":"string","description":"Used to apply user category level [preferences](\"/docs/user-preferences\") on notification trigger.","default":"transactional","isRequired":true,"uniqueKey":"notification_category","typeLabel":"string"},"users":{"type":"array","description":"Array object of target users.","items":{"properties":{"distinct_id":{"type":"string","description":"unique identifier of the user","default":"_distinct_id_","isRequired":true,"uniqueKey":"users.items.[INDEX].distinct_id","typeLabel":"string"},"$channels":{"type":"array","description":"send notification on selected channels in user profile. Following channel keys can be used - email, sms, whatsapp, androidpush, iospush, slack, webpush","default":[],"items":{"type":"string","uniqueKey":"users.items.[INDEX].$channels.items.[INDEX]","typeLabel":"string"},"uniqueKey":"users.items.[INDEX].$channels","typeLabel":"string[]"},"$email":{"type":"array","description":"To trigger notification on a particular email","default":[],"items":{"type":"string","uniqueKey":"users.items.[INDEX].$email.items.[INDEX]","typeLabel":"string"},"uniqueKey":"users.items.[INDEX].$email","typeLabel":"string[]"},"$sms":{"type":"array","description":"Send SMS on a particular number.","default":[],"items":{"type":"string","uniqueKey":"users.items.[INDEX].$sms.items.[INDEX]","typeLabel":"string"},"uniqueKey":"users.items.[INDEX].$sms","typeLabel":"string[]"},"$whatsapp":{"type":"array","description":"Send Whatsapp on a particular number.","default":[],"items":{"type":"string","uniqueKey":"users.items.[INDEX].$whatsapp.items.[INDEX]","typeLabel":"string"},"uniqueKey":"users.items.[INDEX].$whatsapp","typeLabel":"string[]"},"$androidpush":{"type":"array","description":"Send androidpush on the given push token","items":{"type":"string","uniqueKey":"users.items.[INDEX].$androidpush.items.[INDEX]","typeLabel":"string"},"uniqueKey":"users.items.[INDEX].$androidpush","typeLabel":"string[]"},"$iospush":{"type":"array","description":"Send iOSpush on the given push token","items":{"type":"string","uniqueKey":"users.items.[INDEX].$iospush.items.[INDEX]","typeLabel":"string"},"uniqueKey":"users.items.[INDEX].$iospush","typeLabel":"string[]"},"$slack":{"type":"array","description":"Slack channel configuration","items":{"oneOf":[{"type":"object","title":"user email_id","required":["email","access_token"],"properties":{"email":{"type":"string","format":"email","description":"User email address","example":"user@example.com","isRequired":true,"uniqueKey":"users.items.[INDEX].$slack.items.[INDEX].oneOf.0.email","typeLabel":"string\u003cemail>"},"access_token":{"type":"string","description":"Slack bot access token","example":"xoxb-XXXXXXXX","isRequired":true,"uniqueKey":"users.items.[INDEX].$slack.items.[INDEX].oneOf.0.access_token","typeLabel":"string"}},"uniqueKey":"users.items.[INDEX].$slack.items.[INDEX].oneOf.0","typeLabel":"user email_id · object"},{"type":"object","title":"user member_id","required":["user_id","access_token"],"properties":{"user_id":{"type":"string","description":"Slack user ID (U/WXXXXXXXX format)","example":"U/WXXXXXXXX","isRequired":true,"uniqueKey":"users.items.[INDEX].$slack.items.[INDEX].oneOf.1.user_id","typeLabel":"string"},"access_token":{"type":"string","description":"Slack bot access token","example":"xoxb-XXXXXXXX","isRequired":true,"uniqueKey":"users.items.[INDEX].$slack.items.[INDEX].oneOf.1.access_token","typeLabel":"string"}},"uniqueKey":"users.items.[INDEX].$slack.items.[INDEX].oneOf.1","typeLabel":"user member_id · object"},{"type":"object","title":"Slack channel","required":["channel","access_token"],"properties":{"channel":{"type":"string","description":"Slack channel ID (CXXXXXXXX format)","example":"CXXXXXXXX","isRequired":true,"uniqueKey":"users.items.[INDEX].$slack.items.[INDEX].oneOf.2.channel","typeLabel":"string"},"access_token":{"type":"string","description":"Slack bot access token","example":"xoxb-XXXXXX","isRequired":true,"uniqueKey":"users.items.[INDEX].$slack.items.[INDEX].oneOf.2.access_token","typeLabel":"string"}},"uniqueKey":"users.items.[INDEX].$slack.items.[INDEX].oneOf.2","typeLabel":"Slack channel · object"},{"type":"object","title":"Using incoming webhook","required":["incoming_webhook"],"properties":{"incoming_webhook":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"Slack incoming webhook URL","example":"https://hooks.slack.com/services/TXXXX/BXXXX/XXXXXXX","isRequired":true,"uniqueKey":"users.items.[INDEX].$slack.items.[INDEX].oneOf.3.incoming_webhook.url","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"users.items.[INDEX].$slack.items.[INDEX].oneOf.3.incoming_webhook","typeLabel":"object"}},"uniqueKey":"users.items.[INDEX].$slack.items.[INDEX].oneOf.3","typeLabel":"Using incoming webhook · object"}],"uniqueKey":"users.items.[INDEX].$slack.items.[INDEX]","typeLabel":"user email_id · object | user member_id · object | Slack channel · object | Using incoming webhook · object"},"uniqueKey":"users.items.[INDEX].$slack","typeLabel":"(user email_id · object | user member_id · object | Slack channel · object | Using incoming webhook · object)[]"},"$ms_teams":{"type":"array","description":"Microsoft Teams channel configuration","items":{"oneOf":[{"type":"object","title":"MS Teams using conversation ID","required":["tenant_id","service_url","conversation_id"],"properties":{"tenant_id":{"type":"string","description":"Microsoft Teams tenant ID","example":"c1981ab2-9aaf-xxxx-xxxx","isRequired":true,"uniqueKey":"users.items.[INDEX].$ms_teams.items.[INDEX].oneOf.0.tenant_id","typeLabel":"string"},"service_url":{"type":"string","format":"uri","description":"Microsoft Teams service URL","example":"https://smba.trafficmanager.net/amer","isRequired":true,"uniqueKey":"users.items.[INDEX].$ms_teams.items.[INDEX].oneOf.0.service_url","typeLabel":"string\u003curi>"},"conversation_id":{"type":"string","description":"Microsoft Teams conversation ID","example":"19:c1524d7c-a06f-456f-8abe-xxxx","isRequired":true,"uniqueKey":"users.items.[INDEX].$ms_teams.items.[INDEX].oneOf.0.conversation_id","typeLabel":"string"}},"uniqueKey":"users.items.[INDEX].$ms_teams.items.[INDEX].oneOf.0","typeLabel":"MS Teams using conversation ID · object"},{"type":"object","title":"MS Teams using user ID","required":["tenant_id","service_url","user_id"],"properties":{"tenant_id":{"type":"string","description":"Microsoft Teams tenant ID","example":"c1981ab2-9aaf-xxxx-xxxx","isRequired":true,"uniqueKey":"users.items.[INDEX].$ms_teams.items.[INDEX].oneOf.1.tenant_id","typeLabel":"string"},"service_url":{"type":"string","format":"uri","description":"Microsoft Teams service URL","example":"https://smba.trafficmanager.net/amer","isRequired":true,"uniqueKey":"users.items.[INDEX].$ms_teams.items.[INDEX].oneOf.1.service_url","typeLabel":"string\u003curi>"},"user_id":{"type":"string","description":"Microsoft Teams user ID","example":"29:1nsLcmJ2RKtYH6Cxxxx-xxxx","isRequired":true,"uniqueKey":"users.items.[INDEX].$ms_teams.items.[INDEX].oneOf.1.user_id","typeLabel":"string"}},"uniqueKey":"users.items.[INDEX].$ms_teams.items.[INDEX].oneOf.1","typeLabel":"MS Teams using user ID · object"},{"type":"object","title":"MS Teams using incoming webhook","required":["incoming_webhook"],"properties":{"incoming_webhook":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"Microsoft Teams incoming webhook URL","example":"https://wnk1z.webhook.office.com/webhookb2/XXXXXXXXX","isRequired":true,"uniqueKey":"users.items.[INDEX].$ms_teams.items.[INDEX].oneOf.2.incoming_webhook.url","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"users.items.[INDEX].$ms_teams.items.[INDEX].oneOf.2.incoming_webhook","typeLabel":"object"}},"uniqueKey":"users.items.[INDEX].$ms_teams.items.[INDEX].oneOf.2","typeLabel":"MS Teams using incoming webhook · object"}],"uniqueKey":"users.items.[INDEX].$ms_teams.items.[INDEX]","typeLabel":"MS Teams using conversation ID · object | MS Teams using user ID · object | MS Teams using incoming webhook · object"},"uniqueKey":"users.items.[INDEX].$ms_teams","typeLabel":"(MS Teams using conversation ID · object | MS Teams using user ID · object | MS Teams using incoming webhook · object)[]"}},"required":["distinct_id"],"type":"object","uniqueKey":"users.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"users","typeLabel":"object[]"},"data":{"type":"object","description":"variable data required to render dynamic template content or workflow properties like dynamic delay or channel override in send node.","properties":{"$attachments":{"type":"array","description":"Use this key to pass email attachment in the trigger. You can either pass attachment as a public URL or as a base64-encoded file (limit \u003c 50KB).","items":{"oneOf":[{"type":"object","title":"publicly accessible URL","description":"Pass file as **publicly accessible URL** (No limit on file size)","required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"Publicly accessible URL of the file","example":"https://bitcoincore.org/bitcoin.pdf","isRequired":true,"uniqueKey":"data.$attachments.items.[INDEX].oneOf.0.url","typeLabel":"string\u003curi>"},"filename":{"type":"string","description":"Filename to be shown in email","example":"billing.pdf","uniqueKey":"data.$attachments.items.[INDEX].oneOf.0.filename","typeLabel":"string"},"ignore_if_error":{"type":"boolean","description":"Ignore the attachment if it fails to load","uniqueKey":"data.$attachments.items.[INDEX].oneOf.0.ignore_if_error","typeLabel":"boolean"}},"uniqueKey":"data.$attachments.items.[INDEX].oneOf.0","typeLabel":"publicly accessible URL · object"},{"type":"object","title":"base64-encoded file","description":"Pass file as a **base-64 file** (supported limit \u003c 50KB)","required":["data"],"properties":{"data":{"type":"string","description":"Base64-encoded content of the file","isRequired":true,"uniqueKey":"data.$attachments.items.[INDEX].oneOf.1.data","typeLabel":"string"},"filename":{"type":"string","description":"Filename to be shown in email","uniqueKey":"data.$attachments.items.[INDEX].oneOf.1.filename","typeLabel":"string"},"contentType":{"type":"string","example":"application/pdf","uniqueKey":"data.$attachments.items.[INDEX].oneOf.1.contentType","typeLabel":"string"}},"uniqueKey":"data.$attachments.items.[INDEX].oneOf.1","typeLabel":"base64-encoded file · object"}],"uniqueKey":"data.$attachments.items.[INDEX]","typeLabel":"publicly accessible URL · object | base64-encoded file · object"},"uniqueKey":"data.$attachments","typeLabel":"(publicly accessible URL · object | base64-encoded file · object)[]"}},"additionalProperties":{"type":"string","uniqueKey":"data.additionalProperties","typeLabel":"string"},"uniqueKey":"data","typeLabel":"object"},"delivery":{"type":"object","description":"delivery instructions for the workflow. You can set [Smart Delivery](https://docs.suprsend.com/docs/smart-delivery) preference by setting \"smart\":true","properties":{"smart":{"type":"boolean","description":"You can enable smart delivery by setting it true","default":false,"uniqueKey":"delivery.smart","typeLabel":"boolean"},"success":{"type":"string","description":"Success event for stopping further notification in case smart is set to true. You can set notification status like delivery, interaction or custom success event","default":"seen","uniqueKey":"delivery.success","typeLabel":"string"},"time_to_live":{"type":"string","description":"Time window to define delay between subsequent channel trigger in case of smart delivery.\nDelay = `time_to_live / (number_of_channels - 1)`. Format - `XXdXXhXXmXXs` or if its number (n) then delay is in seconds (n)\n","uniqueKey":"delivery.time_to_live","typeLabel":"string"},"mandatory_channels":{"type":"array","description":"Channels on which notification has to be sent immediately in case of smart delivery. Following channel keys can be used - email, sms, whatsapp, androidpush, iospush, slack, webpush","items":{"type":"string","uniqueKey":"delivery.mandatory_channels.items.[INDEX]","typeLabel":"string"},"uniqueKey":"delivery.mandatory_channels","typeLabel":"string[]"}},"uniqueKey":"delivery","typeLabel":"object"},"delay":{"type":"string","description":"Workflow will be halted for the time mentioned in delay, and become active once the delay period is over. Format - `XXdXXhXXmXXs` or if its number (n) then delay is in seconds (n)","uniqueKey":"delay","typeLabel":"string"},"trigger_at":{"type":"string","description":"Trigger workflow on a specific date-time. Format - date string in ISO 8601 e.g. \"2022-08-27T20:14:51.643Z\"","format":"date-time","uniqueKey":"trigger_at","typeLabel":"string\u003cdate-time>"},"tenant_id":{"type":"string","description":"string identifier of the tenant this workflow is associated with","uniqueKey":"tenant_id","typeLabel":"string"},"$idempotency_key":{"type":"string","description":"Unique identifier of the request (deduplicates request for 24hrs)","uniqueKey":"$idempotency_key","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"_workflow_name_","template":"_template_slug_","notification_category":"transactional","users":[{"distinct_id":"_distinct_id_","$channels":[],"$email":[],"$sms":[],"$whatsapp":[],"$androidpush":["\u003cstring>"],"$iospush":["\u003cstring>"],"$slack":[{"email":"user@example.com","access_token":"xoxb-XXXXXXXX"}],"$ms_teams":[{"tenant_id":"c1981ab2-9aaf-xxxx-xxxx","service_url":"https://smba.trafficmanager.net/amer","conversation_id":"19:c1524d7c-a06f-456f-8abe-xxxx"}]}],"data":{"$attachments":[{"url":"https://bitcoincore.org/bitcoin.pdf","filename":"billing.pdf","ignore_if_error":true}]},"delivery":{"smart":false,"success":"seen","time_to_live":"\u003cstring>","mandatory_channels":["\u003cstring>"]},"delay":"\u003cstring>","trigger_at":"2023-11-07T05:31:56Z","tenant_id":"\u003cstring>","$idempotency_key":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"941f8a13-1e54-4132-bc87-4ae9fc3b3bd5":{"description":"202","content":{"text/plain":{"examples":{"Result":{"title":"Result","value":"OK"}},"schema":{"type":"string","example":"OK","uniqueKey":"","typeLabel":"string"},"exampleType":"examples"}},"exampleType":"examples"},"e393cba7-de20-4839-a6af-288cb68d0541":{"description":"400","content":{"text/plain":{"examples":{"Result":{"title":"Result","value":"BAD REQUEST"}},"schema":{"type":"string","example":"BAD REQUEST","description":"Returned as plain text when the `Content-Type` is not `application/json`, or the body (or any item of a batch array) is missing `name`, `template`, `notification_category` or `users`, or `users` is not a non-empty array.","uniqueKey":"","typeLabel":"string"},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"eab191cf-4891-4fba-9990-c9cb4217644e":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API_Key","description":"Pass as `Bearer \u003cAPI_KEY>`. Get API Key from SuprSend dashboard Developers -> API Keys section.","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"eea7dbe4-4763-43a4-939e-87eba61d4470":{"url":"https://hub.suprsend.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API_Key","description":"Pass as `Bearer \u003cAPI_KEY>`. Get API Key from SuprSend dashboard Developers -> API Keys section.","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Pass as `Bearer \u003cAPI_KEY>`. Get API Key from SuprSend dashboard Developers -> API Keys section.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"suprsend","siteName":"SuprSend: API-first notification infrastructure","title":"Dynamic Workflow Trigger - SuprSend: API-first notification infrastructure","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-27T06:01:25.570Z","originalFileLocation":"reference/dynamic-workflow-trigger.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=\"API to dynamically create and trigger a single step workflow.\">\u003cmeta data-mint-head name=\"application-name\" content=\"SuprSend: API-first notification infrastructure\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/suprsend/FnIDjx0xTYX1D8EZ/_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/suprsend/FnIDjx0xTYX1D8EZ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/suprsend/FnIDjx0xTYX1D8EZ/_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/suprsend/FnIDjx0xTYX1D8EZ/_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/suprsend/FnIDjx0xTYX1D8EZ/_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/suprsend/FnIDjx0xTYX1D8EZ/_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/suprsend/FnIDjx0xTYX1D8EZ/_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/suprsend/FnIDjx0xTYX1D8EZ/_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/suprsend/FnIDjx0xTYX1D8EZ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Dynamic Workflow Trigger - SuprSend: API-first notification infrastructure\">\u003cmeta data-mint-head property=\"og:description\" content=\"API to dynamically create and trigger a single step workflow.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"SuprSend: API-first notification infrastructure\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.suprsend.com/reference/dynamic-workflow-trigger\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://suprsend.mintlify.app/_mintlify/api/og/v2?division=TRIGGER+WORKFLOWS\u0026amp;title=Dynamic+Workflow+Trigger\u0026amp;description=API+to+dynamically+create+and+trigger+a+single+step+workflow.\u0026amp;theme=77e430d508312c14f721c90a\u0026amp;signature=28431c44dc15619f3b4f861d8b71c19527aa39e4858487ab4dea5769ad7a3bc6\">\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=\"Dynamic Workflow Trigger - SuprSend: API-first notification infrastructure\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"API to dynamically create and trigger a single step workflow.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://suprsend.mintlify.app/_mintlify/api/og/v2?division=TRIGGER+WORKFLOWS\u0026amp;title=Dynamic+Workflow+Trigger\u0026amp;description=API+to+dynamically+create+and+trigger+a+single+step+workflow.\u0026amp;theme=77e430d508312c14f721c90a\u0026amp;signature=28431c44dc15619f3b4f861d8b71c19527aa39e4858487ab4dea5769ad7a3bc6\">\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/suprsend/FnIDjx0xTYX1D8EZ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"SuprSend: API-first notification infrastructure\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2E70E8\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.suprsend.com/reference/dynamic-workflow-trigger\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/dynamic-workflow-trigger.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.suprsend.com/#organization\",\"name\":\"SuprSend: API-first notification infrastructure\",\"url\":\"https://docs.suprsend.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/suprsend/CMaQBA3E8wM1DyFj/images/suprsend-logo.svg?fit=max\u0026auto=format\u0026n=CMaQBA3E8wM1DyFj\u0026q=85\u0026s=f325b9764c629a0b488476db369b8d47\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.suprsend.com#website\",\"name\":\"SuprSend: API-first notification infrastructure\",\"url\":\"https://docs.suprsend.com\",\"publisher\":{\"@id\":\"https://docs.suprsend.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.suprsend.com/reference/dynamic-workflow-trigger#webpage\",\"url\":\"https://docs.suprsend.com/reference/dynamic-workflow-trigger\",\"name\":\"Dynamic Workflow Trigger\",\"description\":\"API to dynamically create and trigger a single step workflow.\",\"dateModified\":\"2026-01-27T06:01:25.570Z\",\"isPartOf\":{\"@id\":\"https://docs.suprsend.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.suprsend.com/reference/dynamic-workflow-trigger#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.suprsend.com/reference/dynamic-workflow-trigger#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"TRIGGER WORKFLOWS\",\"item\":\"https://docs.suprsend.com/reference/trigger-workflow-api\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Dynamic Workflow Trigger\",\"item\":\"https://docs.suprsend.com/reference/dynamic-workflow-trigger\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.suprsend.com/reference/dynamic-workflow-trigger#apireference\",\"headline\":\"Dynamic Workflow Trigger\",\"name\":\"Dynamic Workflow Trigger\",\"description\":\"API to dynamically create and trigger a single step workflow.\",\"url\":\"https://docs.suprsend.com/reference/dynamic-workflow-trigger\",\"mainEntityOfPage\":{\"@id\":\"https://docs.suprsend.com/reference/dynamic-workflow-trigger#webpage\"},\"dateModified\":\"2026-01-27T06:01:25.570Z\",\"publisher\":{\"@id\":\"https://docs.suprsend.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.suprsend.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"SuprSend: API-first notification infrastructure\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"SuprSend: API-first notification infrastructure","nav":{"global":{"anchors":[{"anchor":"Community","icon":"slack","color":{"light":"#f59f0b","dark":"#f59f0b"},"href":"https://join.slack.com/t/suprsendcommunity/shared_invite/zt-3932rw936-XNWY1RC8bsffh4if4ZyoXQ"},{"anchor":"Trust Center","icon":"shield-halved","color":{"light":"#2564eb","dark":"#2564eb"},"href":"https://trust.suprsend.com"},{"anchor":"Platform Status","icon":"wifi","color":{"light":"#2564eb","dark":"#2564eb"},"href":"https://status.suprsend.com"},{"anchor":"Postman Collection","icon":"code","color":{"light":"#2564eb","dark":"#2564eb"},"href":"https://www.postman.com/suprsend/suprsend/collection/16bdmwa/suprsend-apis"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/docs/what-is-suprsend"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/docs/guides/modelling-customers-workspace-vs-tenant"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"Overview","href":"/reference/overview"},{"title":"Authentication","href":"/reference/authentication"},{"title":"Idempotent Requests","href":"/reference/idempotent-requests"},{"title":"SuprSend APIs on Postman","href":"/reference/postman-collection"}]},{"group":"USERS","pages":[{"title":"Create / Update Users","openapi":"POST /v1/user/{distinct_id}/","sidebarTitle":"Create / Update Users","href":"/reference/create-update-users"},{"title":"Edit User Profile","openapi":"PATCH /v1/user/{distinct_id}/","sidebarTitle":"Edit User Profile","href":"/reference/edit-user-profile"},{"title":"Fetch User by id","openapi":"GET /v1/user/{distinct_id}/","sidebarTitle":"Fetch User by id","href":"/reference/get-user-profile"},{"title":"Upsert User Tenant Profile","openapi":"POST /v1/user/{distinct_id}/tenant/{tenant_id}/","sidebarTitle":"Upsert User Tenant Profile","href":"/reference/upsert-user-tenant-profile"},{"title":"Fetch User Tenant Profile","openapi":"GET /v1/user/{distinct_id}/tenant/{tenant_id}/","sidebarTitle":"Fetch User Tenant Profile","href":"/reference/fetch-user-tenant-profile"},{"title":"List User Tenant Profiles","openapi":"GET /v1/user/{distinct_id}/tenant/","sidebarTitle":"List User Tenant Profiles","href":"/reference/list-user-tenant-profiles"},{"title":"Delete User Tenant Mapping","openapi":"DELETE /v1/user/{distinct_id}/tenant/{tenant_id}/","sidebarTitle":"Delete User Tenant Mapping","href":"/reference/delete-user-tenant-mapping"},{"title":"Fetch User object subscriptions","openapi":"GET /v1/user/{distinct_id}/subscribed_to/object/","sidebarTitle":"Fetch User object subscriptions","href":"/reference/fetch-user-object-subscriptions"},{"title":"Fetch User list subscriptions","openapi":"GET /v1/user/{distinct_id}/subscribed_to/list/","sidebarTitle":"Fetch User list subscriptions","href":"/reference/fetch-user-list-subscriptions"},{"title":"List Users","openapi":"GET /v1/user/","sidebarTitle":"List Users","href":"/reference/list-users"},{"title":"Delete User","openapi":"DELETE /v1/user/{distinct_id}/","sidebarTitle":"Delete User","href":"/reference/delete-user"},{"title":"Merge User Profiles","openapi":"POST /v1/user/{distinct_id}/merge/","sidebarTitle":"Merge User Profiles","href":"/reference/merge-users"}]},{"group":"TRIGGER WORKFLOWS","pages":[{"title":"Trigger Workflow (single or bulk)","openapi":"POST /trigger/","sidebarTitle":"Trigger Workflow","href":"/reference/trigger-workflow-api"},{"title":"Trigger Workflow on a List","openapi":"POST /trigger/list/","sidebarTitle":"Trigger Workflow on List","description":"API to trigger a workflow for every user in a [list](/docs/lists) in one call, via `POST /trigger/list/`.\n\nSuprSend starts one workflow run per list member, with that user as the recipient. Every run gets the same `data` and `tenant_id`. Members are read when the trigger runs: right away, or after `delay` / at `trigger_at` if you schedule it. Dynamic lists are synced before running the workflow or fetching the list of users.\n","href":"/reference/trigger-workflow-on-list"},{"title":"Dynamic Workflow Trigger","openapi":"POST /{workspace_key}/trigger/","sidebarTitle":"Dynamic Workflow Trigger","href":"/reference/dynamic-workflow-trigger"},{"title":"Cancel Workflow","openapi":"POST /v1/workflow_run/cancel/","sidebarTitle":"Cancel Workflow","description":"API to cancel a running workflow execution. You can cancel a workflow by passing any combination of filters in the request body. When multiple parameters are provided, they are **ANDed** together to narrow down the matching workflow runs.\n\nFor example, passing both `workflow` and `recipients` will cancel only the workflow runs that match both the given slug and recipients.\n","href":"/reference/cancel-workflow"}]},{"group":"EVENTS","pages":[{"title":"Trigger an Event","openapi":"POST /event/","sidebarTitle":"Trigger an Event","href":"/reference/trigger-event"}]},{"group":"MESSAGES","pages":[{"title":"List Messages","openapi":"GET /v1/message/","sidebarTitle":"List Messages","href":"/reference/list-messages"},{"title":"Get Message Content","openapi":"GET /v1/message/{message_id}/content/","sidebarTitle":"Get Message Content","href":"/reference/get-message-content"},{"title":"Bulk Update Message Status","openapi":"PATCH /v1/bulk/message/","sidebarTitle":"Bulk Update Message Status","href":"/reference/bulk-update-messages"}]},{"group":"OBJECTS","pages":[{"title":"Create / Update Objects","openapi":"POST /v1/object/{object_type}/{id}/","sidebarTitle":"Create / Update Objects","href":"/reference/create-update-objects"},{"title":"Edit Object Profile","openapi":"PATCH /v1/object/{object_type}/{id}/","sidebarTitle":"Edit Object Profile","href":"/reference/edit-object-profile"},{"title":"Add Subscription","openapi":"POST /v1/object/{object_type}/{id}/subscription/","sidebarTitle":"Add Subscription","href":"/reference/add-object-subscription"},{"title":"Fetch Object by ID","openapi":"GET /v1/object/{object_type}/{id}/","sidebarTitle":"Fetch Object by ID","href":"/reference/get-object-by-id"},{"title":"Fetch Object Subscriptions","openapi":"GET /v1/object/{object_type}/{id}/subscribed_to/object/","sidebarTitle":"Fetch Object Subscriptions","href":"/reference/get-object-subscriptions"},{"title":"List Objects by Type","openapi":"GET /v1/object/{object_type}/","sidebarTitle":"List Objects by Type","href":"/reference/list-objects-by-type"},{"title":"List Object Subscriptions","openapi":"GET /v1/object/{object_type}/{id}/subscription/","sidebarTitle":"List Object Subscriptions","href":"/reference/list-object-subscriptions"},{"title":"Delete an Object","openapi":"DELETE /v1/object/{object_type}/{id}/","sidebarTitle":"Delete an Object","href":"/reference/delete-object"},{"title":"Remove Object Subscriptions","openapi":"DELETE /v1/object/{object_type}/{id}/subscription/","sidebarTitle":"Remove Object Subscriptions","href":"/reference/delete-object-subscription"}]},{"group":"TEMPLATES","pages":[{"title":"Fetch Template List","openapi":"GET /v1/template/","sidebarTitle":"Fetch Template List","href":"/reference/get-template-list"},{"title":"Fetch Template details","openapi":"GET /v1/template/{template_slug}/","sidebarTitle":"Fetch Template details","href":"/reference/get-template-details"},{"title":"Fetch Template content for a Channel","openapi":"GET /v1/template/{template_slug}/channel/{channel_slug}/","sidebarTitle":"Fetch Template content for a channel","href":"/reference/get-template-details-for-channel"}]},{"group":"TENANTS","pages":[{"title":"Create / Update Tenants","openapi":"POST /v1/tenant/{tenant_id}/","sidebarTitle":"Create / Update Tenants","href":"/reference/create-update-tenants"},{"title":"Update Tenant Properties","openapi":"PATCH /v1/tenant/{tenant_id}/properties/","sidebarTitle":"Update Tenant Properties","href":"/reference/update-tenant-properties"},{"title":"Get Tenant","openapi":"GET /v1/tenant/{tenant_id}/","sidebarTitle":"Get Tenant","href":"/reference/get-tenant-data"},{"title":"List Tenants","openapi":"GET /v1/tenant/","sidebarTitle":"List Tenants","href":"/reference/get-tenant-list"},{"title":"Delete Tenant","openapi":"DELETE /v1/tenant/{tenant_id}/","sidebarTitle":"Delete Tenant","href":"/reference/delete-tenant"}]},{"group":"PREFERENCE","pages":[{"group":"Get User Preferences","pages":[{"title":"Full Preference","openapi":"GET /v1/user/{distinct_id}/preference/","sidebarTitle":"Full Preference","href":"/reference/get-user-full-preference"},{"title":"All Categories","openapi":"GET /v1/user/{distinct_id}/preference/category/","sidebarTitle":"All Categories","href":"/reference/user-category-preference"},{"title":"All Channels","openapi":"GET /v1/user/{distinct_id}/preference/channel_preference/","sidebarTitle":"All Channels","href":"/reference/get-user-channel-preferences"},{"title":"Single Category","openapi":"GET /v1/user/{distinct_id}/preference/category/{category_slug}/","sidebarTitle":"Single Category","href":"/reference/get-user-category-preferences"}]},{"group":"Update User Preferences","pages":[{"title":"Update User Full Preference","openapi":"PATCH /v1/user/{distinct_id}/preference/","sidebarTitle":"Update User Full Preference","href":"/reference/update-user-full-preference"},{"title":"Category and Channel within Category","openapi":"PATCH /v1/user/{distinct_id}/preference/category/{category_slug}/","sidebarTitle":"Category and Channel within Category","href":"/reference/update-user-category-preference"},{"title":"Overall Channel level","openapi":"PATCH /v1/user/{distinct_id}/preference/channel_preference/","sidebarTitle":"Overall Channel level","href":"/reference/update-user-channel-preference"},{"title":"Bulk Update","openapi":"PATCH /v1/bulk/user/preference/","sidebarTitle":"Bulk Update","href":"/reference/bulk-update-user-preference"},{"title":"Reset","openapi":"PATCH /v1/bulk/user/preference/reset/","sidebarTitle":"Reset","href":"/reference/reset-user-preferences"}]},{"group":"Manage Tenant Preferences","pages":[{"title":"Get Tenant Full Preference","openapi":"GET /v1/tenant/{tenant_id}/preference/","sidebarTitle":"Get Tenant Full Preference","href":"/reference/get-tenant-full-preference"},{"title":"Get Tenant Preference All Categories","openapi":"GET /v1/tenant/{tenant_id}/preference/category/","sidebarTitle":"Get Tenant Preference All Categories","href":"/reference/get-tenant-preference-all-categories"},{"title":"Get Tenant Preference Single Category","openapi":"GET /v1/tenant/{tenant_id}/preference/category/{category}/","sidebarTitle":"Get Tenant Preference Single Category","href":"/reference/get-tenant-preference-single-category"},{"title":"Update Tenant Preference Single Category","openapi":"PATCH /v1/tenant/{tenant_id}/preference/category/{category}/","sidebarTitle":"Update Tenant Preference Single Category","href":"/reference/update-tenant-preference-single-category"},{"title":"Get Tenant Default Preference","openapi":"GET /v1/tenant/{tenant_id}/category/","sidebarTitle":"Get Tenant Default Preference","href":"/reference/get-tenant-category-preferences"}]},{"group":"Get Object Preferences","pages":[{"title":"Full Preference","openapi":"GET /v1/object/{object_type}/{id}/preference/","sidebarTitle":"Full Preference","href":"/reference/get-object-full-preference"},{"title":"All Categories","openapi":"GET /v1/object/{object_type}/{id}/preference/category/","sidebarTitle":"All Categories","href":"/reference/get-object-category-preference"},{"title":"All Channels","openapi":"GET /v1/object/{object_type}/{id}/preference/channel_preference/","sidebarTitle":"All Channels","href":"/reference/get-object-channel-preferences"},{"title":"Single Category","openapi":"GET /v1/object/{object_type}/{id}/preference/category/{category_slug}/","sidebarTitle":"Single Category","href":"/reference/get-object-single-category-preference"}]},{"group":"Update Object Preferences","pages":[{"title":"Update Object Full Preference","openapi":"PATCH /v1/object/{object_type}/{id}/preference/","sidebarTitle":"Update Object Full Preference","href":"/reference/update-object-full-preference"},{"title":"Category and Channel within Category","openapi":"PATCH /v1/object/{object_type}/{id}/preference/category/{category_slug}/","sidebarTitle":"Category and Channel within Category","href":"/reference/object-preference-category"},{"title":"Overall Channel level","openapi":"PATCH /v1/object/{object_type}/{id}/preference/channel_preference/","sidebarTitle":"Overall Channel level","href":"/reference/update-object-channel-preference"}]}]},{"group":"LISTS","pages":[{"title":"Create a List","openapi":"POST /v1/subscriber_list/","sidebarTitle":"Create a List","href":"/reference/create-list"},{"title":"Add Users to List","openapi":"POST /v1/subscriber_list/{list_id}/subscriber/add/","sidebarTitle":"Add Users to List","href":"/reference/add-user-to-list"},{"title":"Remove Users from List","openapi":"POST /v1/subscriber_list/{list_id}/subscriber/remove/","sidebarTitle":"Remove Users from List","href":"/reference/remove-subscribers-from-list"},{"group":"Replace List Users","pages":[{"title":"Overview","href":"/reference/replace-list-subscribers"},{"title":"Start Sync","openapi":"POST /v1/subscriber_list/{list_id}/start_sync/","sidebarTitle":"Start Sync","href":"/reference/start-sync"},{"title":"Add Users to Draft List","openapi":"POST /v1/subscriber_list/{list_id}/version/{version_id}/subscriber/add/","sidebarTitle":"Add Users to Draft List","href":"/reference/add-subscribers-to-draft-list"},{"title":"Remove Users from Draft List","openapi":"POST /v1/subscriber_list/{list_id}/version/{version_id}/subscriber/remove/","sidebarTitle":"Remove Users from Draft List","href":"/reference/remove-subscribers-from-draft-list"},{"title":"Finish Sync","openapi":"PATCH /v1/subscriber_list/{list_id}/version/{version_id}/finish_sync/","sidebarTitle":"Finish Sync","href":"/reference/finish-sync"},{"title":"Delete Draft List","openapi":"PATCH /v1/subscriber_list/{list_id}/version/{version_id}/delete/","sidebarTitle":"Delete Draft List","href":"/reference/delete-draft-list"}]},{"group":"Segment Lists (dry-run)","pages":[{"title":"Dry-run a segment query (sample rows)","openapi":"POST /v1/subscriber_list/~/dry_run/","sidebarTitle":"Segment dry-run (rows)","href":"/reference/segment-dry-run"},{"title":"Dry-run a segment query (count only)","openapi":"POST /v1/subscriber_list/~/dry_run/count/","sidebarTitle":"Segment dry-run (count)","href":"/reference/segment-dry-run-count"}]},{"title":"Get all Lists","openapi":"GET /v1/subscriber_list/","sidebarTitle":"Get all Lists","href":"/reference/get-all-lists"},{"title":"Get List Configuration","openapi":"GET /v1/subscriber_list/{list_id}/","sidebarTitle":"Get List Configuration","href":"/reference/get-list-details"},{"title":"Get list users","openapi":"GET /v1/subscriber_list/{list_id}/subscriber/","sidebarTitle":"Get list users","href":"/reference/get-list-users"},{"title":"Delete a List","openapi":"PATCH /v1/subscriber_list/{list_id}/delete/","sidebarTitle":"Delete a List","href":"/reference/delete-list"}]},{"group":"BROADCAST","pages":[{"title":"Trigger Broadcast","openapi":"POST /{workspace_key}/broadcast/","sidebarTitle":"Trigger Broadcast","href":"/reference/trigger-broadcast"},{"title":"Cancel Broadcast","openapi":"POST /v1/broadcast_run/cancel/","sidebarTitle":"Cancel Broadcast","href":"/reference/cancel-broadcast"}]}]},{"tab":"Management API","pages":[{"title":"Management API","href":"/docs/management-api-overview"}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/reference/cli-intro"}]},{"tab":"Build with AI","pages":[{"title":"Build with AI","href":"/reference/build-with-ai"}]},{"tab":"Developer Resources","pages":[{"title":"Developer Resources","href":"/docs/developer/overview"}]},{"tab":"Self-Hosted","pages":[{"title":"Self-Hosted","href":"/docs/self-hosted/introduction"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/overview"}]}]},"title":"Dynamic Workflow Trigger - SuprSend: API-first notification infrastructure","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-CBCH2P7b.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}