{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Novu","description":"The open-source notification infrastructure for agents and products. Send, receive, and track notifications across channels.","colors":{"primary":"#0e121b","light":"#FFFFFF","dark":"#FFFFFF"},"logo":{"light":"https://mintcdn.com/novu-c5de82d9/2Q_L4HxwUfLmJjB8/logo/light.svg?fit=max\u0026auto=format\u0026n=2Q_L4HxwUfLmJjB8\u0026q=85\u0026s=23e7050191303b6a0ac4a671dfed8df4","dark":"https://mintcdn.com/novu-c5de82d9/2Q_L4HxwUfLmJjB8/logo/dark.svg?fit=max\u0026auto=format\u0026n=2Q_L4HxwUfLmJjB8\u0026q=85\u0026s=bd7c54f6b7a7b5002ea7b525af3e169c","href":"https://docs.novu.co"},"favicon":"https://mintcdn.com/novu-c5de82d9/ZUl3xXp-4AASlrcI/favicon.svg?fit=max\u0026auto=format\u0026n=ZUl3xXp-4AASlrcI\u0026q=85\u0026s=b53c3afb6a8eaf11aff9db2c5d3f05a1","api":{"openapi":"https://spec.speakeasy.com/novu/novu/json-development-with-code-samples","examples":{"prefill":true}},"background":{},"navbar":{"links":[{"href":"https://novu.co/contact-us","label":"Contact Us"}],"primary":{"type":"button","label":"Get Started","href":"https://dashboard.novu.co/auth/sign-up"}},"footer":{"socials":{"x":"https://x.com/novuhq","github":"https://github.com/novuhq/novu","linkedin":"https://www.linkedin.com/company/novuco"},"links":[{"header":"Comparison","items":[{"label":"Novu vs Courier","href":"https://novu.co/comparison/courier"},{"label":"Novu vs Knock","href":"https://novu.co/comparison/knock"},{"label":"Novu vs MagicBell","href":"https://novu.co/comparison/magicbell"},{"label":"Novu vs SuprSend","href":"https://novu.co/comparison/suprsend"},{"label":"Novu vs In-house","href":"https://novu.co/comparison/building-in-house"}]},{"header":"Resources","items":[{"label":"Contact Support","href":"mailto:support@novu.co"},{"label":"Changelog","href":"https://go.novu.co/changelog?utm_source=docs_footer"},{"label":"Roadmap","href":"https://roadmap.novu.co/roadmap"},{"label":"Contact Sales","href":"https://novu.co/contact-us"},{"label":"Read llms.txt","href":"/llms.txt"}]}]},"seo":{"metatags":{"og:type":"website","twitter:card":"summary_large_image"},"indexing":"all"},"icons":{"library":"lucide"},"integrations":{"gtm":{"tagId":"GTM-KXMC4XP2"},"plausible":{"domain":"docs.novu.co"}},"contextual":{"options":["copy","view","cursor","claude","chatgpt","mcp","add-mcp"],"display":"header"},"thumbnails":{"appearance":"dark","background":"https://mintcdn.com/novu-c5de82d9/vncv7ET97M5-dM6d/images/og/og-image-docs-v2.jpg?fit=max\u0026auto=format\u0026n=vncv7ET97M5-dM6d\u0026q=85\u0026s=26b59f5c597b5b1bea44cbc57cad5e3a","fonts":{"family":"Inter"}},"interaction":{"drilldown":true},"styling":{"latex":false},"navigation":{"global":{"anchors":[]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"novu-c5de82d9","hasAudioNarration":false,"actualSubdomain":"novu-c5de82d9","customDomains":["docs.novu.co"],"gitSource":{"type":"github","owner":"novuhq","repo":"novu","deployBranch":"next","contentDirectory":"docs","isPrivate":false,"mountPath":"","label":""},"chroma":{"collectionId":"8f048910-3f88-41f5-ad0c-1cc4c4200fdd","liveDeploymentHistoryId":"6ae09c48663d8e17af00eaa3","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae09c48663d8e17af00eaa3"},"feedback":{"thumbs":true,"edits":true,"issues":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"}},"buildId":"6ae09c48663d8e17af00eaa3","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"default","tag":"Notify","count":217},{"language":"default","tag":"API Reference","count":160},{"language":"default","tag":"Resources","count":107},{"language":"default","tag":"Integrate Channels Providers","count":93},{"language":"default","tag":"Guides","count":86},{"language":"default","tag":"Data","count":63},{"language":"default","tag":"Getting Started","count":62},{"language":"default","tag":"Framework","count":52},{"language":"default","tag":"Agent Connect","count":41},{"language":"default","tag":"Sms","count":38}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@novu.co","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@media (min-width:1024px){#sidebar-content{width:16rem;min-width:16rem;max-width:16rem}}body:has(#home-content) nav[aria-label=Main] a[aria-current=location]{background:0 0!important;color:rgb(75 85 99)}html.dark body:has(#home-content) nav[aria-label=Main] a[aria-current=location]{color:rgb(156 163 175)}body:has(#home-content) nav[aria-label=Main] a[aria-current=location]:hover{background:rgb(3 7 18/.03)!important;color:rgb(17 24 39)}html.dark body:has(#home-content) nav[aria-label=Main] a[aria-current=location]:hover{background:rgb(255 255 255/.03)!important;color:rgb(229 231 235)}#home-content .hero-cards{margin-top:1.5rem}#home-content .card [data-component-part=card-image]{width:107.5%;max-width:none;margin:-3.75% -3.75% 0}"}],"page":{"pagePath":"api-reference/events/bulk-trigger-event","slug":"/api-reference/events/bulk-trigger-event","pageMetadata":{"title":"Bulk trigger event","openapi":"POST /v1/events/trigger/bulk","description":"\n Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API.\n The bulk API is limited to 100 events per request.\n ","href":"/api-reference/events/bulk-trigger-event"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API.\\nThe bulk API is limited to 100 events per request.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Bulk trigger event","openapi":"POST /v1/events/trigger/bulk","description":"\n Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API.\n The bulk API is limited to 100 events per request.\n ","href":"/api-reference/events/bulk-trigger-event"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"EventsController_triggerBulk","x-speakeasy-group":"","x-speakeasy-usage-example":{"title":"Trigger Notification Events in Bulk"},"x-speakeasy-name-override":"triggerBulk","summary":"Bulk trigger event","description":"\n Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API.\n The bulk API is limited to 100 events per request.\n ","parameters":["3b947fec-e0c6-4287-a339-8072ad1719af"],"requestBody":"97e90305-d2f1-4929-9351-0a2a9ed3a581","responses":{"201":"492ada2e-1acf-4658-a9e9-6fdb9dbf938f","400":"59113385-e064-4e2b-bed4-dcde47626e92","401":"eb303fa9-8ea0-47ac-82ba-fad82ef385a4","403":"74b6c504-68ad-4eb6-a5c3-0bc761abf0e0","404":"e19f1971-9f00-46b7-bafc-5776fd4c10d9","405":"dc77f647-69ae-4caa-8ad1-3c4662f5af5e","409":"8e693ac6-cd59-411a-8ecc-2e9f4ee74443","413":"c906609f-1f7f-45b7-b926-331de7cf6460","414":"0f7456bf-8324-49b3-8e23-9c21d4f05947","415":"1a1e4620-e4b5-49bb-ba86-3797aaf8b746","422":"507f5564-5294-49c4-9b05-27bbbda647db","429":"3c1b40ef-0f68-432a-99dd-a6dc2d881b6c","500":"7df4ea66-eaec-4743-86cc-da2a186d702a","503":"cab64ae7-9a34-4581-aa37-db213cfd3cd4"},"tags":["Events"],"security":["a0c767b4-1874-4ac1-a20f-5a0803917aa8"],"x-codeSamples":[{"lang":"go","label":"Go","source":"package main\n\nimport(\n\t\"context\"\n\t\"github.com/novuhq/novu-go/v3\"\n\t\"github.com/novuhq/novu-go/v3/models/components\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := v3.New(\n v3.WithSecurity(\"YOUR_SECRET_KEY_HERE\"),\n )\n\n res, err := s.TriggerBulk(ctx, components.BulkTriggerEventDto{\n Events: []components.TriggerEventRequestDto{\n components.TriggerEventRequestDto{\n WorkflowID: \"workflow_identifier\",\n Payload: map[string]any{\n \"comment_id\": \"string\",\n \"post\": map[string]any{\n \"text\": \"string\",\n },\n },\n Overrides: \u0026components.Overrides{},\n To: components.CreateTriggerEventRequestDtoToStr(\n \"SUBSCRIBER_ID\",\n ),\n },\n components.TriggerEventRequestDto{\n WorkflowID: \"workflow_identifier\",\n Payload: map[string]any{\n \"comment_id\": \"string\",\n \"post\": map[string]any{\n \"text\": \"string\",\n },\n },\n Overrides: \u0026components.Overrides{},\n To: components.CreateTriggerEventRequestDtoToStr(\n \"SUBSCRIBER_ID\",\n ),\n },\n components.TriggerEventRequestDto{\n WorkflowID: \"workflow_identifier\",\n Payload: map[string]any{\n \"comment_id\": \"string\",\n \"post\": map[string]any{\n \"text\": \"string\",\n },\n },\n Overrides: \u0026components.Overrides{},\n To: components.CreateTriggerEventRequestDtoToStr(\n \"SUBSCRIBER_ID\",\n ),\n },\n },\n }, nil)\n if err != nil {\n log.Fatal(err)\n }\n if res.TriggerEventResponseDtos != nil {\n // handle response\n }\n}"},{"lang":"typescript","label":"TypeScript","source":"import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n secretKey: \"YOUR_SECRET_KEY_HERE\",\n});\n\nasync function run() {\n const result = await novu.triggerBulk({\n events: [\n {\n workflowId: \"workflow_identifier\",\n payload: {\n \"comment_id\": \"string\",\n \"post\": {\n \"text\": \"string\",\n },\n },\n overrides: {},\n to: \"SUBSCRIBER_ID\",\n },\n {\n workflowId: \"workflow_identifier\",\n payload: {\n \"comment_id\": \"string\",\n \"post\": {\n \"text\": \"string\",\n },\n },\n overrides: {},\n to: \"SUBSCRIBER_ID\",\n },\n {\n workflowId: \"workflow_identifier\",\n payload: {\n \"comment_id\": \"string\",\n \"post\": {\n \"text\": \"string\",\n },\n },\n overrides: {},\n to: \"SUBSCRIBER_ID\",\n },\n ],\n });\n\n console.log(result);\n}\n\nrun();"},{"lang":"csharp","label":"Csharp (SDK)","source":"using Novu;\nusing Novu.Models.Components;\nusing System.Collections.Generic;\n\nvar sdk = new NovuSDK(secretKey: \"YOUR_SECRET_KEY_HERE\");\n\nvar res = await sdk.TriggerBulkAsync(bulkTriggerEventDto: new BulkTriggerEventDto() {\n Events = new List\u003cTriggerEventRequestDto>() {\n new TriggerEventRequestDto() {\n WorkflowId = \"workflow_identifier\",\n Payload = new Dictionary\u003cstring, object>() {\n { \"comment_id\", \"string\" },\n { \"post\", new Dictionary\u003cstring, object>() {\n { \"text\", \"string\" },\n } },\n },\n Overrides = new Overrides() {},\n To = TriggerEventRequestDtoTo.CreateStr(\n \"SUBSCRIBER_ID\"\n ),\n },\n new TriggerEventRequestDto() {\n WorkflowId = \"workflow_identifier\",\n Payload = new Dictionary\u003cstring, object>() {\n { \"comment_id\", \"string\" },\n { \"post\", new Dictionary\u003cstring, object>() {\n { \"text\", \"string\" },\n } },\n },\n Overrides = new Overrides() {},\n To = TriggerEventRequestDtoTo.CreateStr(\n \"SUBSCRIBER_ID\"\n ),\n },\n new TriggerEventRequestDto() {\n WorkflowId = \"workflow_identifier\",\n Payload = new Dictionary\u003cstring, object>() {\n { \"comment_id\", \"string\" },\n { \"post\", new Dictionary\u003cstring, object>() {\n { \"text\", \"string\" },\n } },\n },\n Overrides = new Overrides() {},\n To = TriggerEventRequestDtoTo.CreateStr(\n \"SUBSCRIBER_ID\"\n ),\n },\n },\n});\n\n// handle response"},{"lang":"php","label":"PHP","source":"declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse novu;\nuse novu\\Models\\Components;\n\n$sdk = novu\\Novu::builder()\n ->setSecurity(\n 'YOUR_SECRET_KEY_HERE'\n )\n ->build();\n\n$bulkTriggerEventDto = new Components\\BulkTriggerEventDto(\n events: [\n new Components\\TriggerEventRequestDto(\n workflowId: 'workflow_identifier',\n payload: [\n 'comment_id' => 'string',\n 'post' => [\n 'text' => 'string',\n ],\n ],\n overrides: new Components\\Overrides(),\n to: 'SUBSCRIBER_ID',\n ),\n new Components\\TriggerEventRequestDto(\n workflowId: 'workflow_identifier',\n payload: [\n 'comment_id' => 'string',\n 'post' => [\n 'text' => 'string',\n ],\n ],\n overrides: new Components\\Overrides(),\n to: 'SUBSCRIBER_ID',\n ),\n new Components\\TriggerEventRequestDto(\n workflowId: 'workflow_identifier',\n payload: [\n 'comment_id' => 'string',\n 'post' => [\n 'text' => 'string',\n ],\n ],\n overrides: new Components\\Overrides(),\n to: 'SUBSCRIBER_ID',\n ),\n ],\n);\n\n$response = $sdk->triggerBulk(\n bulkTriggerEventDto: $bulkTriggerEventDto\n);\n\nif ($response->triggerEventResponseDtos !== null) {\n // handle response\n}"},{"lang":"python","label":"Python","source":"import novu_py\nfrom novu_py import Novu\n\n\nwith Novu(\n secret_key=\"YOUR_SECRET_KEY_HERE\",\n) as novu:\n\n res = novu.trigger_bulk(bulk_trigger_event_dto={\n \"events\": [\n novu_py.TriggerEventRequestDto(\n workflow_id=\"workflow_identifier\",\n payload={\n \"comment_id\": \"string\",\n \"post\": {\n \"text\": \"string\",\n },\n },\n overrides=novu_py.Overrides(),\n to=\"SUBSCRIBER_ID\",\n ),\n novu_py.TriggerEventRequestDto(\n workflow_id=\"workflow_identifier\",\n payload={\n \"comment_id\": \"string\",\n \"post\": {\n \"text\": \"string\",\n },\n },\n overrides=novu_py.Overrides(),\n to=\"SUBSCRIBER_ID\",\n ),\n novu_py.TriggerEventRequestDto(\n workflow_id=\"workflow_identifier\",\n payload={\n \"comment_id\": \"string\",\n \"post\": {\n \"text\": \"string\",\n },\n },\n overrides=novu_py.Overrides(),\n to=\"SUBSCRIBER_ID\",\n ),\n ],\n })\n\n # Handle response\n print(res)"}],"method":"post","type":"path","servers":["29cc13d7-64c7-40f9-8a35-9c01537b78f4","7588375a-aa7e-462d-a5bf-d94b8564f985"],"path":"/v1/events/trigger/bulk","baseUrlOptions":["https://api.novu.co","https://eu.api.novu.co"],"title":"Bulk trigger event","codeSamples":[{"label":"Go","lang":"go","source":"package main\n\nimport(\n\t\"context\"\n\t\"github.com/novuhq/novu-go/v3\"\n\t\"github.com/novuhq/novu-go/v3/models/components\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := v3.New(\n v3.WithSecurity(\"YOUR_SECRET_KEY_HERE\"),\n )\n\n res, err := s.TriggerBulk(ctx, components.BulkTriggerEventDto{\n Events: []components.TriggerEventRequestDto{\n components.TriggerEventRequestDto{\n WorkflowID: \"workflow_identifier\",\n Payload: map[string]any{\n \"comment_id\": \"string\",\n \"post\": map[string]any{\n \"text\": \"string\",\n },\n },\n Overrides: \u0026components.Overrides{},\n To: components.CreateTriggerEventRequestDtoToStr(\n \"SUBSCRIBER_ID\",\n ),\n },\n components.TriggerEventRequestDto{\n WorkflowID: \"workflow_identifier\",\n Payload: map[string]any{\n \"comment_id\": \"string\",\n \"post\": map[string]any{\n \"text\": \"string\",\n },\n },\n Overrides: \u0026components.Overrides{},\n To: components.CreateTriggerEventRequestDtoToStr(\n \"SUBSCRIBER_ID\",\n ),\n },\n components.TriggerEventRequestDto{\n WorkflowID: \"workflow_identifier\",\n Payload: map[string]any{\n \"comment_id\": \"string\",\n \"post\": map[string]any{\n \"text\": \"string\",\n },\n },\n Overrides: \u0026components.Overrides{},\n To: components.CreateTriggerEventRequestDtoToStr(\n \"SUBSCRIBER_ID\",\n ),\n },\n },\n }, nil)\n if err != nil {\n log.Fatal(err)\n }\n if res.TriggerEventResponseDtos != nil {\n // handle response\n }\n}"},{"label":"TypeScript","lang":"typescript","source":"import { Novu } from \"@novu/api\";\n\nconst novu = new Novu({\n secretKey: \"YOUR_SECRET_KEY_HERE\",\n});\n\nasync function run() {\n const result = await novu.triggerBulk({\n events: [\n {\n workflowId: \"workflow_identifier\",\n payload: {\n \"comment_id\": \"string\",\n \"post\": {\n \"text\": \"string\",\n },\n },\n overrides: {},\n to: \"SUBSCRIBER_ID\",\n },\n {\n workflowId: \"workflow_identifier\",\n payload: {\n \"comment_id\": \"string\",\n \"post\": {\n \"text\": \"string\",\n },\n },\n overrides: {},\n to: \"SUBSCRIBER_ID\",\n },\n {\n workflowId: \"workflow_identifier\",\n payload: {\n \"comment_id\": \"string\",\n \"post\": {\n \"text\": \"string\",\n },\n },\n overrides: {},\n to: \"SUBSCRIBER_ID\",\n },\n ],\n });\n\n console.log(result);\n}\n\nrun();"},{"label":"Csharp (SDK)","lang":"csharp","source":"using Novu;\nusing Novu.Models.Components;\nusing System.Collections.Generic;\n\nvar sdk = new NovuSDK(secretKey: \"YOUR_SECRET_KEY_HERE\");\n\nvar res = await sdk.TriggerBulkAsync(bulkTriggerEventDto: new BulkTriggerEventDto() {\n Events = new List\u003cTriggerEventRequestDto>() {\n new TriggerEventRequestDto() {\n WorkflowId = \"workflow_identifier\",\n Payload = new Dictionary\u003cstring, object>() {\n { \"comment_id\", \"string\" },\n { \"post\", new Dictionary\u003cstring, object>() {\n { \"text\", \"string\" },\n } },\n },\n Overrides = new Overrides() {},\n To = TriggerEventRequestDtoTo.CreateStr(\n \"SUBSCRIBER_ID\"\n ),\n },\n new TriggerEventRequestDto() {\n WorkflowId = \"workflow_identifier\",\n Payload = new Dictionary\u003cstring, object>() {\n { \"comment_id\", \"string\" },\n { \"post\", new Dictionary\u003cstring, object>() {\n { \"text\", \"string\" },\n } },\n },\n Overrides = new Overrides() {},\n To = TriggerEventRequestDtoTo.CreateStr(\n \"SUBSCRIBER_ID\"\n ),\n },\n new TriggerEventRequestDto() {\n WorkflowId = \"workflow_identifier\",\n Payload = new Dictionary\u003cstring, object>() {\n { \"comment_id\", \"string\" },\n { \"post\", new Dictionary\u003cstring, object>() {\n { \"text\", \"string\" },\n } },\n },\n Overrides = new Overrides() {},\n To = TriggerEventRequestDtoTo.CreateStr(\n \"SUBSCRIBER_ID\"\n ),\n },\n },\n});\n\n// handle response"},{"label":"PHP","lang":"php","source":"declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse novu;\nuse novu\\Models\\Components;\n\n$sdk = novu\\Novu::builder()\n ->setSecurity(\n 'YOUR_SECRET_KEY_HERE'\n )\n ->build();\n\n$bulkTriggerEventDto = new Components\\BulkTriggerEventDto(\n events: [\n new Components\\TriggerEventRequestDto(\n workflowId: 'workflow_identifier',\n payload: [\n 'comment_id' => 'string',\n 'post' => [\n 'text' => 'string',\n ],\n ],\n overrides: new Components\\Overrides(),\n to: 'SUBSCRIBER_ID',\n ),\n new Components\\TriggerEventRequestDto(\n workflowId: 'workflow_identifier',\n payload: [\n 'comment_id' => 'string',\n 'post' => [\n 'text' => 'string',\n ],\n ],\n overrides: new Components\\Overrides(),\n to: 'SUBSCRIBER_ID',\n ),\n new Components\\TriggerEventRequestDto(\n workflowId: 'workflow_identifier',\n payload: [\n 'comment_id' => 'string',\n 'post' => [\n 'text' => 'string',\n ],\n ],\n overrides: new Components\\Overrides(),\n to: 'SUBSCRIBER_ID',\n ),\n ],\n);\n\n$response = $sdk->triggerBulk(\n bulkTriggerEventDto: $bulkTriggerEventDto\n);\n\nif ($response->triggerEventResponseDtos !== null) {\n // handle response\n}"},{"label":"Python","lang":"python","source":"import novu_py\nfrom novu_py import Novu\n\n\nwith Novu(\n secret_key=\"YOUR_SECRET_KEY_HERE\",\n) as novu:\n\n res = novu.trigger_bulk(bulk_trigger_event_dto={\n \"events\": [\n novu_py.TriggerEventRequestDto(\n workflow_id=\"workflow_identifier\",\n payload={\n \"comment_id\": \"string\",\n \"post\": {\n \"text\": \"string\",\n },\n },\n overrides=novu_py.Overrides(),\n to=\"SUBSCRIBER_ID\",\n ),\n novu_py.TriggerEventRequestDto(\n workflow_id=\"workflow_identifier\",\n payload={\n \"comment_id\": \"string\",\n \"post\": {\n \"text\": \"string\",\n },\n },\n overrides=novu_py.Overrides(),\n to=\"SUBSCRIBER_ID\",\n ),\n novu_py.TriggerEventRequestDto(\n workflow_id=\"workflow_identifier\",\n payload={\n \"comment_id\": \"string\",\n \"post\": {\n \"text\": \"string\",\n },\n },\n overrides=novu_py.Overrides(),\n to=\"SUBSCRIBER_ID\",\n ),\n ],\n })\n\n # Handle response\n print(res)"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.events.items.0.name":"workflow_identifier","body.events.items.0.to.oneOf.0.items.0.oneOf.0.subscriberId":"\u003cstring>","body.events.items.0.to.oneOf.0.items.0.oneOf.0.firstName.oneOf.0":"John","body.events.items.0.to.oneOf.0.items.0.oneOf.0.lastName.oneOf.0":"Doe","body.events.items.0.to.oneOf.0.items.0.oneOf.0.email.oneOf.0":"john.doe@example.com","body.events.items.0.to.oneOf.0.items.0.oneOf.0.phone.oneOf.0":"+1234567890","body.events.items.0.to.oneOf.0.items.0.oneOf.0.avatar.oneOf.0":"https://example.com/avatar.jpg","body.events.items.0.to.oneOf.0.items.0.oneOf.0.locale.oneOf.0":"en-US","body.events.items.0.to.oneOf.0.items.0.oneOf.0.timezone.oneOf.0":"America/New_York","body.events.items.0.to.oneOf.0.items.0.oneOf.0.data.oneOf.0":{},"body.events.items.0.to.oneOf.0.items.0.oneOf.0.channels.items.0.credentials.webhookUrl":"\u003cstring>","body.events.items.0.to.oneOf.0.items.0.oneOf.0.channels.items.0.credentials.deviceTokens.items.0":"\u003cstring>","body.events.items.0.to.oneOf.0.items.0.oneOf.0.channels.items.0.integrationIdentifier":"\u003cstring>","body.events.items.0.payload":{"comment_id":"string","post":{"text":"string"}},"body.events.items.0.bridgeUrl":"https://your-tunnel.novu.co/api/novu","body.events.items.0.overrides.steps.email-step.providers.sendgrid":{"templateId":"1234567890"},"body.events.items.0.overrides.steps.email-step.layoutId.oneOf.0":"step-specific-layout","body.events.items.0.overrides.channels.email.layoutId.oneOf.0":"promotional-layout-2024","body.events.items.0.overrides.providers.sendgrid":{"templateId":"1234567890"},"body.events.items.0.overrides.email":{},"body.events.items.0.overrides.push":{},"body.events.items.0.overrides.sms":{},"body.events.items.0.overrides.chat":{},"body.events.items.0.overrides.layoutIdentifier":"\u003cstring>","body.events.items.0.agentId.oneOf.0":"support-agent","body.events.items.0.transactionId":"\u003cstring>","body.events.items.0.actor.oneOf.0":"\u003cstring>","body.events.items.0.tenant.oneOf.0":"\u003cstring>"}]},"dependencies":{"parameters":{"3b947fec-e0c6-4287-a339-8072ad1719af":{"name":"idempotency-key","in":"header","description":"A header for idempotency purposes","required":false,"schema":{"type":"string","isRequired":false,"description":"A header for idempotency purposes","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"events":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The trigger identifier of the workflow you wish to send. This identifier can be found on the workflow page.","example":"workflow_identifier","x-speakeasy-name-override":"workflowId","isRequired":true,"uniqueKey":"events.items.[INDEX].name","typeLabel":"string"},"to":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"object","required":["subscriberId"],"properties":{"subscriberId":{"type":"string","description":"The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems","minLength":1,"isRequired":true,"uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.subscriberId","typeLabel":"string"},"firstName":{"oneOf":[{"type":"string","description":"First name of the subscriber","example":"John","uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.firstName.oneOf.0","typeLabel":"string"},{"type":"null","description":"First name of the subscriber","example":"John","uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.firstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"type":"string","description":"Last name of the subscriber","example":"Doe","uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.lastName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Last name of the subscriber","example":"Doe","uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.lastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.lastName","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","description":"Email address of the subscriber","example":"john.doe@example.com","uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","description":"Email address of the subscriber","example":"john.doe@example.com","uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.email","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"Phone number of the subscriber","example":"+1234567890","uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Phone number of the subscriber","example":"+1234567890","uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.phone","typeLabel":"string | null"},"avatar":{"oneOf":[{"type":"string","description":"Avatar URL or identifier","example":"https://example.com/avatar.jpg","uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.avatar.oneOf.0","typeLabel":"string"},{"type":"null","description":"Avatar URL or identifier","example":"https://example.com/avatar.jpg","uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.avatar.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.avatar","typeLabel":"string | null"},"locale":{"oneOf":[{"type":"string","description":"Locale of the subscriber","example":"en-US","uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.locale.oneOf.0","typeLabel":"string"},{"type":"null","description":"Locale of the subscriber","example":"en-US","uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.locale.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.locale","typeLabel":"string | null"},"timezone":{"oneOf":[{"type":"string","description":"Timezone of the subscriber","example":"America/New_York","uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.timezone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Timezone of the subscriber","example":"America/New_York","uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.timezone.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.timezone","typeLabel":"string | null"},"data":{"oneOf":[{"type":"object","description":"Additional custom data associated with the subscriber","additionalProperties":true,"uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.data.oneOf.0","typeLabel":"object"},{"type":"null","description":"Additional custom data associated with the subscriber","additionalProperties":true,"uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.data.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.data","typeLabel":"object | null"},"channels":{"description":"An optional array of subscriber channels.","type":"array","items":{"type":"object","properties":{"providerId":{"type":"string","description":"The ID of the chat or push provider.","enum":["slack","discord","msteams","webex-messaging","mattermost","ryver","zulip","grafana-on-call","getstream","rocket-chat","whatsapp-business","line","chat-webhook","novu-slack","telegram","sendblue","novu-web-chat","fcm","apns","expo","one-signal","pushpad","push-webhook","pusher-beams","appio"],"isRequired":true,"uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.channels.items.[INDEX].providerId","typeLabel":"enum\u003cstring>"},"credentials":{"type":"object","description":"Credentials for the channel.","properties":{"webhookUrl":{"type":"string","description":"The URL for the webhook associated with the channel.","uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.channels.items.[INDEX].credentials.webhookUrl","typeLabel":"string"},"deviceTokens":{"description":"An array of device tokens for push notifications.","type":"array","items":{"type":"string","uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.channels.items.[INDEX].credentials.deviceTokens.items.[INDEX]","typeLabel":"string"},"uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.channels.items.[INDEX].credentials.deviceTokens","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.channels.items.[INDEX].credentials","typeLabel":"object"},"integrationIdentifier":{"type":"string","description":"An optional identifier for the integration.","uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.channels.items.[INDEX].integrationIdentifier","typeLabel":"string"}},"required":["providerId","credentials"],"uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.channels.items.[INDEX]","typeLabel":"object"},"uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0.channels","typeLabel":"object[]"}},"uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["topicKey","type"],"properties":{"topicKey":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.1.topicKey","typeLabel":"string"},"type":{"type":"string","enum":["Subscriber","Topic"],"isRequired":true,"uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"exclude":{"description":"Optional array of subscriber IDs to exclude from the topic trigger","type":"array","items":{"type":"string","uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.1.exclude.items.[INDEX]","typeLabel":"string"},"uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.1.exclude","typeLabel":"string[]"}},"uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"string","description":"Unique identifier of a subscriber in your systems","minLength":1,"example":"SUBSCRIBER_ID","uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX].oneOf.2","typeLabel":"string"}],"uniqueKey":"events.items.[INDEX].to.oneOf.0.items.[INDEX]","typeLabel":"object · object · string"},"description":"The recipients list of people who will receive the notification. Maximum number of recipients can be 100.","isRequired":true,"uniqueKey":"events.items.[INDEX].to.oneOf.0","typeLabel":"object · object · string[]"},{"type":"string","description":"The recipients list of people who will receive the notification. Maximum number of recipients can be 100.","minLength":1,"example":"SUBSCRIBER_ID","isRequired":true,"uniqueKey":"events.items.[INDEX].to.oneOf.1","typeLabel":"string"},{"type":"object","description":"The recipients list of people who will receive the notification. Maximum number of recipients can be 100.","required":["subscriberId"],"properties":{"subscriberId":{"type":"string","description":"The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems","minLength":1,"isRequired":true,"uniqueKey":"events.items.[INDEX].to.oneOf.2.subscriberId","typeLabel":"string"},"firstName":{"oneOf":[{"type":"string","description":"First name of the subscriber","example":"John","uniqueKey":"events.items.[INDEX].to.oneOf.2.firstName.oneOf.0","typeLabel":"string"},{"type":"null","description":"First name of the subscriber","example":"John","uniqueKey":"events.items.[INDEX].to.oneOf.2.firstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].to.oneOf.2.firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"type":"string","description":"Last name of the subscriber","example":"Doe","uniqueKey":"events.items.[INDEX].to.oneOf.2.lastName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Last name of the subscriber","example":"Doe","uniqueKey":"events.items.[INDEX].to.oneOf.2.lastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].to.oneOf.2.lastName","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","description":"Email address of the subscriber","example":"john.doe@example.com","uniqueKey":"events.items.[INDEX].to.oneOf.2.email.oneOf.0","typeLabel":"string"},{"type":"null","description":"Email address of the subscriber","example":"john.doe@example.com","uniqueKey":"events.items.[INDEX].to.oneOf.2.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].to.oneOf.2.email","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"Phone number of the subscriber","example":"+1234567890","uniqueKey":"events.items.[INDEX].to.oneOf.2.phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Phone number of the subscriber","example":"+1234567890","uniqueKey":"events.items.[INDEX].to.oneOf.2.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].to.oneOf.2.phone","typeLabel":"string | null"},"avatar":{"oneOf":[{"type":"string","description":"Avatar URL or identifier","example":"https://example.com/avatar.jpg","uniqueKey":"events.items.[INDEX].to.oneOf.2.avatar.oneOf.0","typeLabel":"string"},{"type":"null","description":"Avatar URL or identifier","example":"https://example.com/avatar.jpg","uniqueKey":"events.items.[INDEX].to.oneOf.2.avatar.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].to.oneOf.2.avatar","typeLabel":"string | null"},"locale":{"oneOf":[{"type":"string","description":"Locale of the subscriber","example":"en-US","uniqueKey":"events.items.[INDEX].to.oneOf.2.locale.oneOf.0","typeLabel":"string"},{"type":"null","description":"Locale of the subscriber","example":"en-US","uniqueKey":"events.items.[INDEX].to.oneOf.2.locale.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].to.oneOf.2.locale","typeLabel":"string | null"},"timezone":{"oneOf":[{"type":"string","description":"Timezone of the subscriber","example":"America/New_York","uniqueKey":"events.items.[INDEX].to.oneOf.2.timezone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Timezone of the subscriber","example":"America/New_York","uniqueKey":"events.items.[INDEX].to.oneOf.2.timezone.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].to.oneOf.2.timezone","typeLabel":"string | null"},"data":{"oneOf":[{"type":"object","description":"Additional custom data associated with the subscriber","additionalProperties":true,"uniqueKey":"events.items.[INDEX].to.oneOf.2.data.oneOf.0","typeLabel":"object"},{"type":"null","description":"Additional custom data associated with the subscriber","additionalProperties":true,"uniqueKey":"events.items.[INDEX].to.oneOf.2.data.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].to.oneOf.2.data","typeLabel":"object | null"},"channels":{"description":"An optional array of subscriber channels.","type":"array","items":{"type":"object","properties":{"providerId":{"type":"string","description":"The ID of the chat or push provider.","enum":["slack","discord","msteams","webex-messaging","mattermost","ryver","zulip","grafana-on-call","getstream","rocket-chat","whatsapp-business","line","chat-webhook","novu-slack","telegram","sendblue","novu-web-chat","fcm","apns","expo","one-signal","pushpad","push-webhook","pusher-beams","appio"],"isRequired":true,"uniqueKey":"events.items.[INDEX].to.oneOf.2.channels.items.[INDEX].providerId","typeLabel":"enum\u003cstring>"},"credentials":{"type":"object","description":"Credentials for the channel.","properties":{"webhookUrl":{"type":"string","description":"The URL for the webhook associated with the channel.","uniqueKey":"events.items.[INDEX].to.oneOf.2.channels.items.[INDEX].credentials.webhookUrl","typeLabel":"string"},"deviceTokens":{"description":"An array of device tokens for push notifications.","type":"array","items":{"type":"string","uniqueKey":"events.items.[INDEX].to.oneOf.2.channels.items.[INDEX].credentials.deviceTokens.items.[INDEX]","typeLabel":"string"},"uniqueKey":"events.items.[INDEX].to.oneOf.2.channels.items.[INDEX].credentials.deviceTokens","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].to.oneOf.2.channels.items.[INDEX].credentials","typeLabel":"object"},"integrationIdentifier":{"type":"string","description":"An optional identifier for the integration.","uniqueKey":"events.items.[INDEX].to.oneOf.2.channels.items.[INDEX].integrationIdentifier","typeLabel":"string"}},"required":["providerId","credentials"],"uniqueKey":"events.items.[INDEX].to.oneOf.2.channels.items.[INDEX]","typeLabel":"object"},"uniqueKey":"events.items.[INDEX].to.oneOf.2.channels","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].to.oneOf.2","typeLabel":"object"},{"type":"object","description":"The recipients list of people who will receive the notification. Maximum number of recipients can be 100.","required":["topicKey","type"],"properties":{"topicKey":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"events.items.[INDEX].to.oneOf.3.topicKey","typeLabel":"string"},"type":{"type":"string","enum":["Subscriber","Topic"],"isRequired":true,"uniqueKey":"events.items.[INDEX].to.oneOf.3.type","typeLabel":"enum\u003cstring>"},"exclude":{"description":"Optional array of subscriber IDs to exclude from the topic trigger","type":"array","items":{"type":"string","uniqueKey":"events.items.[INDEX].to.oneOf.3.exclude.items.[INDEX]","typeLabel":"string"},"uniqueKey":"events.items.[INDEX].to.oneOf.3.exclude","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].to.oneOf.3","typeLabel":"object"}],"isRequired":true,"uniqueKey":"events.items.[INDEX].to","typeLabel":"object · object · string[] · string · object · object"},"payload":{"type":"object","description":"The payload object is used to pass additional custom information that could be \n used to render the workflow, or perform routing rules based on it. \n This data will also be available when fetching the notifications feed from the API to display certain parts of the UI.","additionalProperties":true,"example":{"comment_id":"string","post":{"text":"string"}},"uniqueKey":"events.items.[INDEX].payload","typeLabel":"object"},"bridgeUrl":{"type":"string","description":"Optional Bridge Endpoint URL used to route this trigger to a specific Bridge application. Useful during local development when multiple engineers share an organization: set this to your personal tunnel URL from `npx novu@latest dev` (for example via NOVU_BRIDGE_URL) so app-fired triggers hit your machine instead of the environment's synced Bridge URL. Must be a publicly reachable https URL — private or localhost addresses are rejected.","example":"https://your-tunnel.novu.co/api/novu","uniqueKey":"events.items.[INDEX].bridgeUrl","typeLabel":"string"},"overrides":{"type":"object","description":"This could be used to override provider specific configurations","properties":{"steps":{"type":"object","description":"This could be used to override provider specific configurations or layout at the step level","example":{"email-step":{"providers":{"sendgrid":{"templateId":"1234567890"}},"layoutId":"step-specific-layout"}},"additionalProperties":{"type":"object","properties":{"providers":{"type":"object","description":"Passing the provider id and the provider specific configurations","example":{"sendgrid":{"templateId":"1234567890"}},"additionalProperties":{"type":"object","additionalProperties":true,"uniqueKey":"events.items.[INDEX].overrides.steps.additionalProperties.providers.additionalProperties","typeLabel":"object"},"uniqueKey":"events.items.[INDEX].overrides.steps.additionalProperties.providers","typeLabel":"object"},"layoutId":{"oneOf":[{"type":"string","description":"Override the or remove the layout for this specific step","example":"welcome-email-layout","uniqueKey":"events.items.[INDEX].overrides.steps.additionalProperties.layoutId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Override the or remove the layout for this specific step","example":"welcome-email-layout","uniqueKey":"events.items.[INDEX].overrides.steps.additionalProperties.layoutId.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].overrides.steps.additionalProperties.layoutId","typeLabel":"string | null"}},"uniqueKey":"events.items.[INDEX].overrides.steps.additionalProperties","typeLabel":"object"},"uniqueKey":"events.items.[INDEX].overrides.steps","typeLabel":"object"},"channels":{"type":"object","description":"Channel-specific overrides that apply to all steps of a particular channel type. Step-level overrides take precedence over channel-level overrides.","example":{"email":{"layoutId":"promotional-layout-2024"}},"properties":{"email":{"type":"object","description":"Email channel specific overrides","properties":{"layoutId":{"oneOf":[{"type":"string","description":"Override or remove the layout for all email steps in the workflow","example":"promotional-layout-2024","uniqueKey":"events.items.[INDEX].overrides.channels.email.layoutId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Override or remove the layout for all email steps in the workflow","example":"promotional-layout-2024","uniqueKey":"events.items.[INDEX].overrides.channels.email.layoutId.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].overrides.channels.email.layoutId","typeLabel":"string | null"}},"uniqueKey":"events.items.[INDEX].overrides.channels.email","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].overrides.channels","typeLabel":"object"},"providers":{"type":"object","description":"Overrides the provider configuration for the entire workflow and all steps","example":{"sendgrid":{"templateId":"1234567890"}},"additionalProperties":{"type":"object","additionalProperties":true,"uniqueKey":"events.items.[INDEX].overrides.providers.additionalProperties","typeLabel":"object"},"uniqueKey":"events.items.[INDEX].overrides.providers","typeLabel":"object"},"email":{"type":"object","description":"Override the email provider specific configurations for the entire workflow","deprecated":true,"additionalProperties":true,"uniqueKey":"events.items.[INDEX].overrides.email","typeLabel":"object"},"push":{"type":"object","description":"Override the push provider specific configurations for the entire workflow","deprecated":true,"additionalProperties":true,"uniqueKey":"events.items.[INDEX].overrides.push","typeLabel":"object"},"sms":{"type":"object","description":"Override the sms provider specific configurations for the entire workflow","deprecated":true,"additionalProperties":true,"uniqueKey":"events.items.[INDEX].overrides.sms","typeLabel":"object"},"chat":{"type":"object","description":"Override the chat provider specific configurations for the entire workflow","deprecated":true,"additionalProperties":true,"uniqueKey":"events.items.[INDEX].overrides.chat","typeLabel":"object"},"layoutIdentifier":{"type":"string","description":"Override the layout identifier for the entire workflow","deprecated":true,"uniqueKey":"events.items.[INDEX].overrides.layoutIdentifier","typeLabel":"string"},"severity":{"type":"string","description":"Severity of the workflow","enum":["high","medium","low","none"],"uniqueKey":"events.items.[INDEX].overrides.severity","typeLabel":"enum\u003cstring>"}},"uniqueKey":"events.items.[INDEX].overrides","typeLabel":"object"},"agentId":{"oneOf":[{"type":"string","description":"Override the workflow-assigned agent for this trigger using the public agent identifier. Omit to use the workflow default; pass null to disable agent routing for this execution.","example":"support-agent","uniqueKey":"events.items.[INDEX].agentId.oneOf.0","typeLabel":"string"},{"type":"null","description":"Override the workflow-assigned agent for this trigger using the public agent identifier. Omit to use the workflow default; pass null to disable agent routing for this execution.","example":"support-agent","uniqueKey":"events.items.[INDEX].agentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].agentId","typeLabel":"string | null"},"transactionId":{"type":"string","description":"A unique identifier for deduplication. If the same **transactionId** is sent again, \n the trigger is ignored. Useful to prevent duplicate notifications. The retention period depends on your billing tier.","uniqueKey":"events.items.[INDEX].transactionId","typeLabel":"string"},"actor":{"oneOf":[{"type":"string","description":"It is used to display the Avatar of the provided actor's subscriber id or actor object.\n\n\n\n\n\n\n If a new actor object is provided, we will create a new subscriber in our system","uniqueKey":"events.items.[INDEX].actor.oneOf.0","typeLabel":"string"},{"type":"object","description":"It is used to display the Avatar of the provided actor's subscriber id or actor object.\n\n\n\n\n\n\n If a new actor object is provided, we will create a new subscriber in our system","required":["subscriberId"],"properties":{"subscriberId":{"type":"string","description":"The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems","minLength":1,"isRequired":true,"uniqueKey":"events.items.[INDEX].actor.oneOf.1.subscriberId","typeLabel":"string"},"firstName":{"oneOf":[{"type":"string","description":"First name of the subscriber","example":"John","uniqueKey":"events.items.[INDEX].actor.oneOf.1.firstName.oneOf.0","typeLabel":"string"},{"type":"null","description":"First name of the subscriber","example":"John","uniqueKey":"events.items.[INDEX].actor.oneOf.1.firstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].actor.oneOf.1.firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"type":"string","description":"Last name of the subscriber","example":"Doe","uniqueKey":"events.items.[INDEX].actor.oneOf.1.lastName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Last name of the subscriber","example":"Doe","uniqueKey":"events.items.[INDEX].actor.oneOf.1.lastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].actor.oneOf.1.lastName","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","description":"Email address of the subscriber","example":"john.doe@example.com","uniqueKey":"events.items.[INDEX].actor.oneOf.1.email.oneOf.0","typeLabel":"string"},{"type":"null","description":"Email address of the subscriber","example":"john.doe@example.com","uniqueKey":"events.items.[INDEX].actor.oneOf.1.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].actor.oneOf.1.email","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"Phone number of the subscriber","example":"+1234567890","uniqueKey":"events.items.[INDEX].actor.oneOf.1.phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Phone number of the subscriber","example":"+1234567890","uniqueKey":"events.items.[INDEX].actor.oneOf.1.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].actor.oneOf.1.phone","typeLabel":"string | null"},"avatar":{"oneOf":[{"type":"string","description":"Avatar URL or identifier","example":"https://example.com/avatar.jpg","uniqueKey":"events.items.[INDEX].actor.oneOf.1.avatar.oneOf.0","typeLabel":"string"},{"type":"null","description":"Avatar URL or identifier","example":"https://example.com/avatar.jpg","uniqueKey":"events.items.[INDEX].actor.oneOf.1.avatar.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].actor.oneOf.1.avatar","typeLabel":"string | null"},"locale":{"oneOf":[{"type":"string","description":"Locale of the subscriber","example":"en-US","uniqueKey":"events.items.[INDEX].actor.oneOf.1.locale.oneOf.0","typeLabel":"string"},{"type":"null","description":"Locale of the subscriber","example":"en-US","uniqueKey":"events.items.[INDEX].actor.oneOf.1.locale.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].actor.oneOf.1.locale","typeLabel":"string | null"},"timezone":{"oneOf":[{"type":"string","description":"Timezone of the subscriber","example":"America/New_York","uniqueKey":"events.items.[INDEX].actor.oneOf.1.timezone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Timezone of the subscriber","example":"America/New_York","uniqueKey":"events.items.[INDEX].actor.oneOf.1.timezone.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].actor.oneOf.1.timezone","typeLabel":"string | null"},"data":{"oneOf":[{"type":"object","description":"Additional custom data associated with the subscriber","additionalProperties":true,"uniqueKey":"events.items.[INDEX].actor.oneOf.1.data.oneOf.0","typeLabel":"object"},{"type":"null","description":"Additional custom data associated with the subscriber","additionalProperties":true,"uniqueKey":"events.items.[INDEX].actor.oneOf.1.data.oneOf.1","typeLabel":"null"}],"uniqueKey":"events.items.[INDEX].actor.oneOf.1.data","typeLabel":"object | null"},"channels":{"description":"An optional array of subscriber channels.","type":"array","items":{"type":"object","properties":{"providerId":{"type":"string","description":"The ID of the chat or push provider.","enum":["slack","discord","msteams","webex-messaging","mattermost","ryver","zulip","grafana-on-call","getstream","rocket-chat","whatsapp-business","line","chat-webhook","novu-slack","telegram","sendblue","novu-web-chat","fcm","apns","expo","one-signal","pushpad","push-webhook","pusher-beams","appio"],"isRequired":true,"uniqueKey":"events.items.[INDEX].actor.oneOf.1.channels.items.[INDEX].providerId","typeLabel":"enum\u003cstring>"},"credentials":{"type":"object","description":"Credentials for the channel.","properties":{"webhookUrl":{"type":"string","description":"The URL for the webhook associated with the channel.","uniqueKey":"events.items.[INDEX].actor.oneOf.1.channels.items.[INDEX].credentials.webhookUrl","typeLabel":"string"},"deviceTokens":{"description":"An array of device tokens for push notifications.","type":"array","items":{"type":"string","uniqueKey":"events.items.[INDEX].actor.oneOf.1.channels.items.[INDEX].credentials.deviceTokens.items.[INDEX]","typeLabel":"string"},"uniqueKey":"events.items.[INDEX].actor.oneOf.1.channels.items.[INDEX].credentials.deviceTokens","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"events.items.[INDEX].actor.oneOf.1.channels.items.[INDEX].credentials","typeLabel":"object"},"integrationIdentifier":{"type":"string","description":"An optional identifier for the integration.","uniqueKey":"events.items.[INDEX].actor.oneOf.1.channels.items.[INDEX].integrationIdentifier","typeLabel":"string"}},"required":["providerId","credentials"],"uniqueKey":"events.items.[INDEX].actor.oneOf.1.channels.items.[INDEX]","typeLabel":"object"},"uniqueKey":"events.items.[INDEX].actor.oneOf.1.channels","typeLabel":"object[]"}},"uniqueKey":"events.items.[INDEX].actor.oneOf.1","typeLabel":"object"}],"uniqueKey":"events.items.[INDEX].actor","typeLabel":"string | object"},"tenant":{"oneOf":[{"type":"string","description":"It is used to specify a tenant context during trigger event.\n Existing tenants will be updated with the provided details.","uniqueKey":"events.items.[INDEX].tenant.oneOf.0","typeLabel":"string"},{"type":"object","description":"It is used to specify a tenant context during trigger event.\n Existing tenants will be updated with the provided details.","properties":{"identifier":{"type":"string","uniqueKey":"events.items.[INDEX].tenant.oneOf.1.identifier","typeLabel":"string"},"name":{"type":"string","uniqueKey":"events.items.[INDEX].tenant.oneOf.1.name","typeLabel":"string"},"data":{"type":"object","uniqueKey":"events.items.[INDEX].tenant.oneOf.1.data","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].tenant.oneOf.1","typeLabel":"object"}],"uniqueKey":"events.items.[INDEX].tenant","typeLabel":"string | object"},"context":{"type":"object","additionalProperties":{"oneOf":[{"type":"string","description":"Simple context id","example":"org-acme","uniqueKey":"events.items.[INDEX].context.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"object","description":"Rich context object with id and optional data","required":["id"],"properties":{"id":{"type":"string","example":"org-acme","isRequired":true,"uniqueKey":"events.items.[INDEX].context.additionalProperties.oneOf.1.id","typeLabel":"string"},"data":{"type":"object","description":"Optional additional context data","additionalProperties":true,"example":{"name":"Acme Corp","region":"us-east-1"},"uniqueKey":"events.items.[INDEX].context.additionalProperties.oneOf.1.data","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX].context.additionalProperties.oneOf.1","typeLabel":"object"}],"uniqueKey":"events.items.[INDEX].context.additionalProperties","typeLabel":"string | object"},"uniqueKey":"events.items.[INDEX].context","typeLabel":"object"}},"required":["name","to"],"uniqueKey":"events.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"events","typeLabel":"object[]"}},"required":["events"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"events":[{"name":"workflow_identifier","to":[{"subscriberId":"\u003cstring>","firstName":"John","lastName":"Doe","email":"john.doe@example.com","phone":"+1234567890","avatar":"https://example.com/avatar.jpg","locale":"en-US","timezone":"America/New_York","data":{},"channels":[{"credentials":{"webhookUrl":"\u003cstring>","deviceTokens":["\u003cstring>"]},"integrationIdentifier":"\u003cstring>"}]}],"payload":{"comment_id":"string","post":{"text":"string"}},"bridgeUrl":"https://your-tunnel.novu.co/api/novu","overrides":{"steps":{"email-step":{"providers":{"sendgrid":{"templateId":"1234567890"}},"layoutId":"step-specific-layout"}},"channels":{"email":{"layoutId":"promotional-layout-2024"}},"providers":{"sendgrid":{"templateId":"1234567890"}},"email":{},"push":{},"sms":{},"chat":{},"layoutIdentifier":"\u003cstring>"},"agentId":"support-agent","transactionId":"\u003cstring>","actor":"\u003cstring>","tenant":"\u003cstring>","context":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"492ada2e-1acf-4658-a9e9-6fdb9dbf938f":{"description":"Created","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"acknowledged":{"type":"boolean","description":"Indicates whether the trigger was acknowledged or not","isRequired":true,"uniqueKey":"items.[INDEX].acknowledged","typeLabel":"boolean"},"status":{"enum":["error","trigger_not_active","no_workflow_active_steps_defined","no_workflow_steps_defined","processed","no_tenant_found","invalid_recipients"],"type":"string","description":"Status of the trigger","isRequired":true,"uniqueKey":"items.[INDEX].status","typeLabel":"enum\u003cstring>"},"error":{"description":"In case of an error, this field will contain the error message(s)","type":"array","items":{"type":"string","uniqueKey":"items.[INDEX].error.items.[INDEX]","typeLabel":"string"},"uniqueKey":"items.[INDEX].error","typeLabel":"string[]"},"transactionId":{"type":"string","description":"The returned transaction ID of the trigger","uniqueKey":"items.[INDEX].transactionId","typeLabel":"string"},"activityFeedLink":{"type":"string","description":"Link to the activity feed for this trigger event","uniqueKey":"items.[INDEX].activityFeedLink","typeLabel":"string"},"jobData":{"type":"object","uniqueKey":"items.[INDEX].jobData","typeLabel":"object"}},"required":["acknowledged","status"],"uniqueKey":"items.[INDEX]","typeLabel":"object"},"uniqueKey":"","typeLabel":"object[]"},"examples":{"Example":{"title":"Example","value":[{"acknowledged":true,"status":"error","error":["\u003cstring>"],"transactionId":"\u003cstring>","activityFeedLink":"\u003cstring>","jobData":{}}]}},"exampleType":"generated"}},"exampleType":"generated"},"59113385-e064-4e2b-bed4-dcde47626e92":{"description":"Payload validation failed - returned when any event payload does not match the workflow schema","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error response.","example":404,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"timestamp":{"type":"string","description":"Timestamp of when the error occurred.","example":"2024-12-12T13:00:00Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"path":{"type":"string","description":"The path where the error occurred.","example":"/api/v1/resource","isRequired":true,"uniqueKey":"path","typeLabel":"string"},"type":{"type":"string","description":"Type identifier for payload validation errors","example":"PAYLOAD_VALIDATION_ERROR","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"errors":{"description":"Array of detailed validation errors","example":[{"field":"user.name","message":"must have required property 'name'","value":{"age":25},"schemaPath":"#/required"}],"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"Field path that failed validation","example":"user.name","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","description":"Validation error message","example":"must have required property 'name'","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"value":{"oneOf":[{"type":"string","description":"The actual value that failed validation","example":{"age":25},"uniqueKey":"errors.items.[INDEX].value.oneOf.0","typeLabel":"string"},{"type":"null","description":"The actual value that failed validation","example":{"age":25},"uniqueKey":"errors.items.[INDEX].value.oneOf.1","typeLabel":"null"},{"type":"number","description":"The actual value that failed validation","example":{"age":25},"uniqueKey":"errors.items.[INDEX].value.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"The actual value that failed validation","example":{"age":25},"uniqueKey":"errors.items.[INDEX].value.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"The actual value that failed validation","example":{"age":25},"uniqueKey":"errors.items.[INDEX].value.oneOf.4","typeLabel":"object"},{"type":"null","description":"The actual value that failed validation","example":{"age":25},"uniqueKey":"errors.items.[INDEX].value.oneOf.5","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"errors.items.[INDEX].value.oneOf.6.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"errors.items.[INDEX].value.oneOf.6.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"errors.items.[INDEX].value.oneOf.6.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"errors.items.[INDEX].value.oneOf.6.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"errors.items.[INDEX].value.oneOf.6.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"errors.items.[INDEX].value.oneOf.6.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"The actual value that failed validation","example":{"age":25},"uniqueKey":"errors.items.[INDEX].value.oneOf.6","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"errors.items.[INDEX].value","typeLabel":"string · null · number · boolean · object · null · (string | null | number | boolean | object)[]"},"schemaPath":{"type":"string","description":"JSON Schema path where the validation failed","example":"#/required","uniqueKey":"errors.items.[INDEX].schemaPath","typeLabel":"string"}},"required":["field","message"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"},"message":{"oneOf":[{"type":"string","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.1","typeLabel":"null"},{"type":"number","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.4","typeLabel":"object"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.5","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"message.oneOf.6.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.6","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"message","typeLabel":"string · null · number · boolean · object · null · (string | null | number | boolean | object)[]"},"ctx":{"type":"object","description":"Optional context object for additional error details.","additionalProperties":true,"example":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"uniqueKey":"ctx","typeLabel":"object"},"errorId":{"type":"string","description":"Optional unique identifier for the error, useful for tracking using Sentry and \n New Relic, only available for 500.","example":"abc123","uniqueKey":"errorId","typeLabel":"string"},"schema":{"type":"object","description":"The JSON schema that was used for validation","example":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"number"}},"required":["name"]},"uniqueKey":"schema","typeLabel":"object"}},"required":["statusCode","timestamp","path","type","errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"timestamp":"2024-12-12T13:00:00Z","path":"/api/v1/resource","type":"PAYLOAD_VALIDATION_ERROR","errors":[{"field":"user.name","message":"must have required property 'name'","value":{"age":25},"schemaPath":"#/required"}],"message":"xx xx xx ","ctx":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"errorId":"abc123","schema":{"type":"object","properties":{"name":{"type":"string"},"age":{"type":"number"}},"required":["name"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"eb303fa9-8ea0-47ac-82ba-fad82ef385a4":{"description":"Unauthorized","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error response.","example":404,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"timestamp":{"type":"string","description":"Timestamp of when the error occurred.","example":"2024-12-12T13:00:00Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"path":{"type":"string","description":"The path where the error occurred.","example":"/api/v1/resource","isRequired":true,"uniqueKey":"path","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.1","typeLabel":"null"},{"type":"number","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.4","typeLabel":"object"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.5","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"message.oneOf.6.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.6","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"message","typeLabel":"string · null · number · boolean · object · null · (string | null | number | boolean | object)[]"},"ctx":{"type":"object","description":"Optional context object for additional error details.","additionalProperties":true,"example":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"uniqueKey":"ctx","typeLabel":"object"},"errorId":{"type":"string","description":"Optional unique identifier for the error, useful for tracking using Sentry and \n New Relic, only available for 500.","example":"abc123","uniqueKey":"errorId","typeLabel":"string"}},"required":["statusCode","timestamp","path"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"timestamp":"2024-12-12T13:00:00Z","path":"/api/v1/resource","message":"xx xx xx ","ctx":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"errorId":"abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"74b6c504-68ad-4eb6-a5c3-0bc761abf0e0":{"description":"Forbidden","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error response.","example":404,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"timestamp":{"type":"string","description":"Timestamp of when the error occurred.","example":"2024-12-12T13:00:00Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"path":{"type":"string","description":"The path where the error occurred.","example":"/api/v1/resource","isRequired":true,"uniqueKey":"path","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.1","typeLabel":"null"},{"type":"number","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.4","typeLabel":"object"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.5","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"message.oneOf.6.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.6","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"message","typeLabel":"string · null · number · boolean · object · null · (string | null | number | boolean | object)[]"},"ctx":{"type":"object","description":"Optional context object for additional error details.","additionalProperties":true,"example":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"uniqueKey":"ctx","typeLabel":"object"},"errorId":{"type":"string","description":"Optional unique identifier for the error, useful for tracking using Sentry and \n New Relic, only available for 500.","example":"abc123","uniqueKey":"errorId","typeLabel":"string"}},"required":["statusCode","timestamp","path"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"timestamp":"2024-12-12T13:00:00Z","path":"/api/v1/resource","message":"xx xx xx ","ctx":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"errorId":"abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"e19f1971-9f00-46b7-bafc-5776fd4c10d9":{"description":"Not Found","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error response.","example":404,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"timestamp":{"type":"string","description":"Timestamp of when the error occurred.","example":"2024-12-12T13:00:00Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"path":{"type":"string","description":"The path where the error occurred.","example":"/api/v1/resource","isRequired":true,"uniqueKey":"path","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.1","typeLabel":"null"},{"type":"number","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.4","typeLabel":"object"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.5","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"message.oneOf.6.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.6","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"message","typeLabel":"string · null · number · boolean · object · null · (string | null | number | boolean | object)[]"},"ctx":{"type":"object","description":"Optional context object for additional error details.","additionalProperties":true,"example":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"uniqueKey":"ctx","typeLabel":"object"},"errorId":{"type":"string","description":"Optional unique identifier for the error, useful for tracking using Sentry and \n New Relic, only available for 500.","example":"abc123","uniqueKey":"errorId","typeLabel":"string"}},"required":["statusCode","timestamp","path"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"timestamp":"2024-12-12T13:00:00Z","path":"/api/v1/resource","message":"xx xx xx ","ctx":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"errorId":"abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"dc77f647-69ae-4caa-8ad1-3c4662f5af5e":{"description":"Method Not Allowed","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error response.","example":404,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"timestamp":{"type":"string","description":"Timestamp of when the error occurred.","example":"2024-12-12T13:00:00Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"path":{"type":"string","description":"The path where the error occurred.","example":"/api/v1/resource","isRequired":true,"uniqueKey":"path","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.1","typeLabel":"null"},{"type":"number","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.4","typeLabel":"object"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.5","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"message.oneOf.6.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.6","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"message","typeLabel":"string · null · number · boolean · object · null · (string | null | number | boolean | object)[]"},"ctx":{"type":"object","description":"Optional context object for additional error details.","additionalProperties":true,"example":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"uniqueKey":"ctx","typeLabel":"object"},"errorId":{"type":"string","description":"Optional unique identifier for the error, useful for tracking using Sentry and \n New Relic, only available for 500.","example":"abc123","uniqueKey":"errorId","typeLabel":"string"}},"required":["statusCode","timestamp","path"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"timestamp":"2024-12-12T13:00:00Z","path":"/api/v1/resource","message":"xx xx xx ","ctx":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"errorId":"abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"8e693ac6-cd59-411a-8ecc-2e9f4ee74443":{"description":"Conflict","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error response.","example":404,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"timestamp":{"type":"string","description":"Timestamp of when the error occurred.","example":"2024-12-12T13:00:00Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"path":{"type":"string","description":"The path where the error occurred.","example":"/api/v1/resource","isRequired":true,"uniqueKey":"path","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.1","typeLabel":"null"},{"type":"number","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.4","typeLabel":"object"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.5","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"message.oneOf.6.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.6","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"message","typeLabel":"string · null · number · boolean · object · null · (string | null | number | boolean | object)[]"},"ctx":{"type":"object","description":"Optional context object for additional error details.","additionalProperties":true,"example":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"uniqueKey":"ctx","typeLabel":"object"},"errorId":{"type":"string","description":"Optional unique identifier for the error, useful for tracking using Sentry and \n New Relic, only available for 500.","example":"abc123","uniqueKey":"errorId","typeLabel":"string"}},"required":["statusCode","timestamp","path"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"timestamp":"2024-12-12T13:00:00Z","path":"/api/v1/resource","message":"xx xx xx ","ctx":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"errorId":"abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"c906609f-1f7f-45b7-b926-331de7cf6460":{"description":"Payload Too Large","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error response.","example":404,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"timestamp":{"type":"string","description":"Timestamp of when the error occurred.","example":"2024-12-12T13:00:00Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"path":{"type":"string","description":"The path where the error occurred.","example":"/api/v1/resource","isRequired":true,"uniqueKey":"path","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.1","typeLabel":"null"},{"type":"number","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.4","typeLabel":"object"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.5","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"message.oneOf.6.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.6","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"message","typeLabel":"string · null · number · boolean · object · null · (string | null | number | boolean | object)[]"},"ctx":{"type":"object","description":"Optional context object for additional error details.","additionalProperties":true,"example":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"uniqueKey":"ctx","typeLabel":"object"},"errorId":{"type":"string","description":"Optional unique identifier for the error, useful for tracking using Sentry and \n New Relic, only available for 500.","example":"abc123","uniqueKey":"errorId","typeLabel":"string"}},"required":["statusCode","timestamp","path"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"timestamp":"2024-12-12T13:00:00Z","path":"/api/v1/resource","message":"xx xx xx ","ctx":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"errorId":"abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"0f7456bf-8324-49b3-8e23-9c21d4f05947":{"description":"URI Too Long","content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error response.","example":404,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"timestamp":{"type":"string","description":"Timestamp of when the error occurred.","example":"2024-12-12T13:00:00Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"path":{"type":"string","description":"The path where the error occurred.","example":"/api/v1/resource","isRequired":true,"uniqueKey":"path","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.1","typeLabel":"null"},{"type":"number","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.4","typeLabel":"object"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.5","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"message.oneOf.6.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.6","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"message","typeLabel":"string · null · number · boolean · object · null · (string | null | number | boolean | object)[]"},"ctx":{"type":"object","description":"Optional context object for additional error details.","additionalProperties":true,"example":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"uniqueKey":"ctx","typeLabel":"object"},"errorId":{"type":"string","description":"Optional unique identifier for the error, useful for tracking using Sentry and \n New Relic, only available for 500.","example":"abc123","uniqueKey":"errorId","typeLabel":"string"}},"required":["statusCode","timestamp","path"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"timestamp":"2024-12-12T13:00:00Z","path":"/api/v1/resource","message":"xx xx xx ","ctx":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"errorId":"abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"1a1e4620-e4b5-49bb-ba86-3797aaf8b746":{"description":"Unsupported Media Type","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error response.","example":404,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"timestamp":{"type":"string","description":"Timestamp of when the error occurred.","example":"2024-12-12T13:00:00Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"path":{"type":"string","description":"The path where the error occurred.","example":"/api/v1/resource","isRequired":true,"uniqueKey":"path","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.1","typeLabel":"null"},{"type":"number","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.4","typeLabel":"object"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.5","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"message.oneOf.6.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.6","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"message","typeLabel":"string · null · number · boolean · object · null · (string | null | number | boolean | object)[]"},"ctx":{"type":"object","description":"Optional context object for additional error details.","additionalProperties":true,"example":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"uniqueKey":"ctx","typeLabel":"object"},"errorId":{"type":"string","description":"Optional unique identifier for the error, useful for tracking using Sentry and \n New Relic, only available for 500.","example":"abc123","uniqueKey":"errorId","typeLabel":"string"}},"required":["statusCode","timestamp","path"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"timestamp":"2024-12-12T13:00:00Z","path":"/api/v1/resource","message":"xx xx xx ","ctx":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"errorId":"abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"507f5564-5294-49c4-9b05-27bbbda647db":{"description":"Unprocessable Entity","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error response.","example":404,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"timestamp":{"type":"string","description":"Timestamp of when the error occurred.","example":"2024-12-12T13:00:00Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"path":{"type":"string","description":"The path where the error occurred.","example":"/api/v1/resource","isRequired":true,"uniqueKey":"path","typeLabel":"string"},"errors":{"type":"object","description":"A record of validation errors keyed by field name","additionalProperties":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"string","uniqueKey":"errors.additionalProperties.messages.items.[INDEX]","typeLabel":"string"},"description":"List of validation error messages","example":["Field is required","Invalid format"],"isRequired":true,"uniqueKey":"errors.additionalProperties.messages","typeLabel":"string[]"},"value":{"oneOf":[{"type":"string","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"errors.additionalProperties.value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"errors.additionalProperties.value.oneOf.1","typeLabel":"null"},{"type":"number","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"errors.additionalProperties.value.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"errors.additionalProperties.value.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"errors.additionalProperties.value.oneOf.4","typeLabel":"object"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"errors.additionalProperties.value.oneOf.5.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"errors.additionalProperties.value.oneOf.5.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"errors.additionalProperties.value.oneOf.5.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"errors.additionalProperties.value.oneOf.5.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"errors.additionalProperties.value.oneOf.5.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"errors.additionalProperties.value.oneOf.5.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"errors.additionalProperties.value.oneOf.5","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"errors.additionalProperties.value","typeLabel":"string | null | number | boolean | object | (string | null | number | boolean | object)[]"}},"required":["messages"],"uniqueKey":"errors.additionalProperties","typeLabel":"object"},"example":{"fieldName1":{"messages":["Field is required","Must be a valid email address"],"value":"invalidEmail"},"fieldName2":{"messages":["Must be at least 18 years old"],"value":17},"fieldName3":{"messages":["Must be a boolean value"],"value":true},"fieldName4":{"messages":["Must be a valid object"],"value":{"key":"value"}},"fieldName5":{"messages":["Field is missing"],"value":null},"fieldName6":{"messages":["Undefined value"]}},"isRequired":true,"uniqueKey":"errors","typeLabel":"object"},"message":{"oneOf":[{"type":"string","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.1","typeLabel":"null"},{"type":"number","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.4","typeLabel":"object"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.5","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"message.oneOf.6.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.6","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"message","typeLabel":"string · null · number · boolean · object · null · (string | null | number | boolean | object)[]"},"ctx":{"type":"object","description":"Optional context object for additional error details.","additionalProperties":true,"example":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"uniqueKey":"ctx","typeLabel":"object"},"errorId":{"type":"string","description":"Optional unique identifier for the error, useful for tracking using Sentry and \n New Relic, only available for 500.","example":"abc123","uniqueKey":"errorId","typeLabel":"string"}},"required":["statusCode","timestamp","path","errors"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"timestamp":"2024-12-12T13:00:00Z","path":"/api/v1/resource","errors":{"fieldName1":{"messages":["Field is required","Must be a valid email address"],"value":"invalidEmail"},"fieldName2":{"messages":["Must be at least 18 years old"],"value":17},"fieldName3":{"messages":["Must be a boolean value"],"value":true},"fieldName4":{"messages":["Must be a valid object"],"value":{"key":"value"}},"fieldName5":{"messages":["Field is missing"],"value":null},"fieldName6":{"messages":["Undefined value"]}},"message":"xx xx xx ","ctx":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"errorId":"abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"3c1b40ef-0f68-432a-99dd-a6dc2d881b6c":{"description":"The client has sent too many requests in a given amount of time. ","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"},"Retry-After":{"required":false,"description":"The number of seconds after which the client may retry the request that was previously rejected.","schema":{"type":"string"},"example":"8"}},"content":{"application/json":{"schema":{"type":"string","example":"API rate limit exceeded","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"API rate limit exceeded"}},"exampleType":"generated"}},"exampleType":"generated"},"7df4ea66-eaec-4743-86cc-da2a186d702a":{"description":"Internal Server Error","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP status code of the error response.","example":404,"isRequired":true,"uniqueKey":"statusCode","typeLabel":"number"},"timestamp":{"type":"string","description":"Timestamp of when the error occurred.","example":"2024-12-12T13:00:00Z","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string"},"path":{"type":"string","description":"The path where the error occurred.","example":"/api/v1/resource","isRequired":true,"uniqueKey":"path","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.1","typeLabel":"null"},{"type":"number","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.2","typeLabel":"number"},{"type":"boolean","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.3","typeLabel":"boolean"},{"type":"object","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.4","typeLabel":"object"},{"type":"null","description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.5","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"number","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.2","typeLabel":"number"},{"type":"boolean","uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.3","typeLabel":"boolean"},{"type":"object","additionalProperties":true,"uniqueKey":"message.oneOf.6.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"message.oneOf.6.items.[INDEX]","typeLabel":"string | null | number | boolean | object"},"description":"Value that failed validation","example":"xx xx xx ","uniqueKey":"message.oneOf.6","typeLabel":"(string | null | number | boolean | object)[]"}],"uniqueKey":"message","typeLabel":"string · null · number · boolean · object · null · (string | null | number | boolean | object)[]"},"ctx":{"type":"object","description":"Optional context object for additional error details.","additionalProperties":true,"example":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"uniqueKey":"ctx","typeLabel":"object"},"errorId":{"type":"string","description":"Optional unique identifier for the error, useful for tracking using Sentry and \n New Relic, only available for 500.","example":"abc123","uniqueKey":"errorId","typeLabel":"string"}},"required":["statusCode","timestamp","path"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"statusCode":404,"timestamp":"2024-12-12T13:00:00Z","path":"/api/v1/resource","message":"xx xx xx ","ctx":{"workflowId":"some_wf_id","stepId":"some_wf_id"},"errorId":"abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"cab64ae7-9a34-4581-aa37-db213cfd3cd4":{"description":"The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.","headers":{"Content-Type":{"required":true,"description":"The MIME type of the response body.","schema":{"type":"string"},"example":"application/json"},"RateLimit-Limit":{"required":false,"description":"The number of requests that the client is permitted to make per second. The actual maximum may differ when burst is enabled.","schema":{"type":"string"},"example":"100"},"RateLimit-Remaining":{"required":false,"description":"The number of requests remaining until the next window.","schema":{"type":"string"},"example":"93"},"RateLimit-Reset":{"required":false,"description":"The remaining seconds until a request of the same cost will be refreshed.","schema":{"type":"string"},"example":"8"},"RateLimit-Policy":{"required":false,"description":"The rate limit policy that was used to evaluate the request.","schema":{"type":"string"},"example":"100;w=1;burst=110;comment=\"token bucket\";category=\"trigger\";cost=\"single\""},"Idempotency-Key":{"required":false,"description":"The idempotency key used to evaluate the request.","schema":{"type":"string"},"example":"8"},"Idempotency-Replay":{"required":false,"description":"Whether the request was a replay of a previous request.","schema":{"type":"string"},"example":"true"},"Retry-After":{"required":false,"description":"The number of seconds after which the client may retry the request that was previously rejected.","schema":{"type":"string"},"example":"8"}},"content":{"application/json":{"schema":{"type":"string","example":"Please wait some time, then try again.","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"Please wait some time, then try again."}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"a0c767b4-1874-4ac1-a20f-5a0803917aa8":{"secretKey":{"type":"apiKey","name":"Authorization","in":"header","description":"API key authentication. Allowed headers-- \"Authorization: ApiKey \u003cnovu_secret_key>\".","x-speakeasy-example":"YOUR_SECRET_KEY_HERE","scopes":[]}}},"servers":{"29cc13d7-64c7-40f9-8a35-9c01537b78f4":{"url":"https://api.novu.co"},"7588375a-aa7e-462d-a5bf-d94b8564f985":{"url":"https://eu.api.novu.co"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"Authorization","in":"header","description":"API key authentication. Allowed headers-- \"Authorization: ApiKey \u003cnovu_secret_key>\".","x-speakeasy-example":"YOUR_SECRET_KEY_HERE","scopes":[]},"schema":{"title":"Authorization","type":"string","description":"API key authentication. Allowed headers-- \"Authorization: ApiKey \u003cnovu_secret_key>\".","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"secretKey","name":"Authorization"}],"title":"secretKey"}]},"originalFileLocation":"https://spec.speakeasy.com/novu/novu/json-development-with-code-samples"},"subdomain":"novu-c5de82d9","siteName":"Novu","title":"Bulk trigger event - Novu","contextualStarterQuestions":[{"_id":"6a4617871acb1ee4e52cb7de","deploymentId":"6a3b890b89d2acbacf3fa68a","questionText":"How do I bulk trigger events?","status":"active","generatedBy":"contextual","path":"api-reference/events/bulk-trigger-event","createdAt":"2026-07-02T07:47:19.733Z","updatedAt":"2026-07-02T07:47:19.733Z","__v":0},{"_id":"6a4617871acb1ee4e52cb7e0","deploymentId":"6a3b890b89d2acbacf3fa68a","questionText":"How do I use the REST API?","status":"active","generatedBy":"contextual","path":"api-reference/events/bulk-trigger-event","createdAt":"2026-07-02T07:47:19.733Z","updatedAt":"2026-07-02T07:47:19.733Z","__v":0},{"_id":"6a4617871acb1ee4e52cb7df","deploymentId":"6a3b890b89d2acbacf3fa68a","questionText":"What auth does bulk trigger need?","status":"active","generatedBy":"contextual","path":"api-reference/events/bulk-trigger-event","createdAt":"2026-07-02T07:47:19.733Z","updatedAt":"2026-07-02T07:47:19.733Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-09T07:59:59.058Z","originalFileLocation":"api-reference/events/bulk-trigger-event.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API. The bulk API is limited to 100 events per request.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Novu\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/novu-c5de82d9/hif-BqO_gbG8zfWr/_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/novu-c5de82d9/hif-BqO_gbG8zfWr/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/novu-c5de82d9/hif-BqO_gbG8zfWr/_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/novu-c5de82d9/hif-BqO_gbG8zfWr/_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/novu-c5de82d9/hif-BqO_gbG8zfWr/_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/novu-c5de82d9/hif-BqO_gbG8zfWr/_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/novu-c5de82d9/hif-BqO_gbG8zfWr/_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/novu-c5de82d9/hif-BqO_gbG8zfWr/_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/novu-c5de82d9/hif-BqO_gbG8zfWr/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Bulk trigger event - Novu\">\u003cmeta data-mint-head property=\"og:description\" content=\"Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API. The bulk API is limited to 100 events per request.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Novu\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.novu.co/api-reference/events/bulk-trigger-event\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://novu-c5de82d9.mintlify.app/_mintlify/api/og/v2?division=Events\u0026amp;title=Bulk+trigger+event\u0026amp;description=%0A++++++Using+this+endpoint+you+can+trigger+multiple+events+at+once%2C+to+avoid+multiple+calls+to+the+API.%0A++++++The+bulk+API+is+limited+to+100+events+per+request.\u0026amp;theme=1ee19fc55ed421ff750b0681\u0026amp;signature=b7c2b35a1f63ca0546d35ac3b517e941f540124a4c146ca6374c564f3d9b7ae6\">\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=\"Bulk trigger event - Novu\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API. The bulk API is limited to 100 events per request.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://novu-c5de82d9.mintlify.app/_mintlify/api/og/v2?division=Events\u0026amp;title=Bulk+trigger+event\u0026amp;description=%0A++++++Using+this+endpoint+you+can+trigger+multiple+events+at+once%2C+to+avoid+multiple+calls+to+the+API.%0A++++++The+bulk+API+is+limited+to+100+events+per+request.\u0026amp;theme=1ee19fc55ed421ff750b0681\u0026amp;signature=b7c2b35a1f63ca0546d35ac3b517e941f540124a4c146ca6374c564f3d9b7ae6\">\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/novu-c5de82d9/hif-BqO_gbG8zfWr/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Novu\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0e121b\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.novu.co/api-reference/events/bulk-trigger-event\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/events/bulk-trigger-event.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.novu.co/#organization\",\"name\":\"Novu\",\"url\":\"https://docs.novu.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/novu-c5de82d9/2Q_L4HxwUfLmJjB8/logo/light.svg?fit=max\u0026auto=format\u0026n=2Q_L4HxwUfLmJjB8\u0026q=85\u0026s=23e7050191303b6a0ac4a671dfed8df4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.novu.co#website\",\"name\":\"Novu\",\"url\":\"https://docs.novu.co\",\"publisher\":{\"@id\":\"https://docs.novu.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.novu.co/api-reference/events/bulk-trigger-event#webpage\",\"url\":\"https://docs.novu.co/api-reference/events/bulk-trigger-event\",\"name\":\"Bulk trigger event\",\"description\":\"Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API. The bulk API is limited to 100 events per request.\",\"dateModified\":\"2026-07-09T07:59:59.058Z\",\"isPartOf\":{\"@id\":\"https://docs.novu.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.novu.co/api-reference/events/bulk-trigger-event#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.novu.co/api-reference/events/bulk-trigger-event#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Notification delivery\",\"item\":\"https://docs.novu.co/api-reference/events/trigger-event\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Events\",\"item\":\"https://docs.novu.co/api-reference/events/trigger-event\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Bulk trigger event\",\"item\":\"https://docs.novu.co/api-reference/events/bulk-trigger-event\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.novu.co/api-reference/events/bulk-trigger-event#apireference\",\"headline\":\"Bulk trigger event\",\"name\":\"Bulk trigger event\",\"description\":\"Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API. The bulk API is limited to 100 events per request.\",\"url\":\"https://docs.novu.co/api-reference/events/bulk-trigger-event\",\"mainEntityOfPage\":{\"@id\":\"https://docs.novu.co/api-reference/events/bulk-trigger-event#webpage\"},\"dateModified\":\"2026-07-09T07:59:59.058Z\",\"publisher\":{\"@id\":\"https://docs.novu.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.novu.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Novu\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Novu","nav":{"global":{"anchors":[]},"tabs":[{"tab":"Notify","pages":[{"title":"Notify","href":"/platform"}]},{"tab":"Agent Connect","pages":[{"title":"Agent Connect","href":"/agents"}]},{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"Novu REST API Reference","sidebarTitle":"Overview","href":"/api-reference"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Errors","href":"/api-reference/errors"},{"title":"Pagination","href":"/api-reference/pagination"},{"title":"Rate Limiting","href":"/api-reference/rate-limiting"},{"title":"Idempotency","href":"/api-reference/idempotency"},{"title":"Payload Limits","href":"/api-reference/payload-limits"}]},{"group":"Notification delivery","icon":"send","pages":[{"group":"Events","expanded":false,"pages":[{"title":"Trigger event","openapi":"POST /v1/events/trigger","description":" Trigger event is the main (and only) way to send notifications to subscribers. The trigger identifier is used to match the particular workflow associated with it. Maximum number of recipients can be 100. Additional information can be passed according the body interface below.\n To prevent duplicate triggers, you can optionally pass a **transactionId** in the request body. If the same **transactionId** is used again, the trigger will be ignored. The retention period depends on your billing tier.","href":"/api-reference/events/trigger-event"},{"title":"Bulk trigger event","openapi":"POST /v1/events/trigger/bulk","href":"/api-reference/events/bulk-trigger-event"},{"title":"Broadcast event to all","openapi":"POST /v1/events/trigger/broadcast","description":"Trigger a broadcast event to all existing subscribers, could be used to send announcements, etc.\n\n\n\n\n\n\n In the future could be used to trigger events to a subset of subscribers based on defined filters.","href":"/api-reference/events/broadcast-event-to-all"},{"title":"Cancel triggered event","openapi":"DELETE /v1/events/trigger/{transactionId}","href":"/api-reference/events/cancel-triggered-event"}]},{"group":"Notifications","expanded":false,"pages":[{"title":"Notification event schema","sidebarTitle":"Schema","href":"/api-reference/notifications/notification-event-schema"},{"title":"List all events","openapi":"GET /v1/notifications","href":"/api-reference/notifications/list-all-events"},{"title":"Retrieve an event","openapi":"GET /v1/notifications/{notificationId}","href":"/api-reference/notifications/retrieve-an-event"}]},{"group":"Messages","expanded":false,"pages":[{"title":"Message schema","sidebarTitle":"Schema","href":"/api-reference/messages/message-schema"},{"title":"List all messages","openapi":"GET /v1/messages","href":"/api-reference/messages/list-all-messages"},{"title":"Delete a message","openapi":"DELETE /v1/messages/{messageId}","href":"/api-reference/messages/delete-a-message"},{"title":"Delete messages by transactionId","openapi":"DELETE /v1/messages/transaction/{transactionId}","href":"/api-reference/messages/delete-messages-by-transactionid"}]},{"group":"Activity","expanded":false,"pages":[{"title":"Track activity and engagement events","openapi":"POST /v2/inbound-webhooks/delivery-providers/{environmentId}/{integrationId}","href":"/api-reference/activity/track-activity-and-engagement-events"}]}]},{"group":"Agents","icon":"bot","pages":[{"title":"Agent schema","sidebarTitle":"Schema","href":"/api-reference/agents/agent-schema"},{"group":"Management","expanded":false,"pages":[{"title":"Create an agent","openapi":"POST /v1/agents","href":"/api-reference/agents/create-an-agent"},{"title":"List all agents","openapi":"GET /v1/agents","href":"/api-reference/agents/list-all-agents"},{"title":"Retrieve an agent","openapi":"GET /v1/agents/{identifier}","href":"/api-reference/agents/retrieve-an-agent"},{"title":"Update an agent","openapi":"PATCH /v1/agents/{identifier}","href":"/api-reference/agents/update-an-agent"},{"title":"Delete an agent","openapi":"DELETE /v1/agents/{identifier}","href":"/api-reference/agents/delete-an-agent"}]},{"group":"Runtime","expanded":false,"pages":[{"title":"Update an agent bridge","openapi":"PUT /v1/agents/{identifier}/bridge","href":"/api-reference/agents/update-an-agent-bridge"},{"title":"Send an agent reply","openapi":"POST /v1/agents/{agentId}/reply","href":"/api-reference/agents/send-an-agent-reply"}]},{"group":"Integrations","expanded":false,"pages":[{"title":"Create an agent integration","openapi":"POST /v1/agents/{identifier}/integrations","href":"/api-reference/agents/create-an-agent-integration"},{"title":"List agent integrations","openapi":"GET /v1/agents/{identifier}/integrations","href":"/api-reference/agents/list-agent-integrations"},{"title":"Update an agent integration","openapi":"PATCH /v1/agents/{identifier}/integrations/{agentIntegrationId}","href":"/api-reference/agents/update-an-agent-integration"},{"title":"Delete an agent integration","openapi":"DELETE /v1/agents/{identifier}/integrations/{agentIntegrationId}","href":"/api-reference/agents/delete-an-agent-integration"}]}]},{"group":"Data","icon":"database","pages":[{"group":"Subscribers","expanded":false,"pages":[{"title":"Subscriber schema","sidebarTitle":"Schema","href":"/api-reference/subscribers/subscriber-schema"},{"group":"Management","expanded":false,"pages":[{"title":"Create a subscriber","openapi":"POST /v2/subscribers","href":"/api-reference/subscribers/create-a-subscriber"},{"title":"Retrieve a subscriber","openapi":"GET /v2/subscribers/{subscriberId}","href":"/api-reference/subscribers/retrieve-a-subscriber"},{"title":"Update a subscriber","openapi":"PATCH /v2/subscribers/{subscriberId}","href":"/api-reference/subscribers/update-a-subscriber"},{"title":"Delete a subscriber","openapi":"DELETE /v2/subscribers/{subscriberId}","href":"/api-reference/subscribers/delete-a-subscriber"},{"title":"Search subscribers","openapi":"GET /v2/subscribers","href":"/api-reference/subscribers/search-subscribers"},{"title":"Bulk create subscribers","openapi":"POST /v1/subscribers/bulk","href":"/api-reference/subscribers/bulk-create-subscribers"}]},{"group":"Subscriptions","expanded":false,"pages":[{"title":"Retrieve subscriber subscriptions","openapi":"GET /v2/subscribers/{subscriberId}/subscriptions","href":"/api-reference/subscribers/retrieve-subscriber-subscriptions"}]},{"group":"Preferences","expanded":false,"pages":[{"title":"Retrieve subscriber preferences","openapi":"GET /v2/subscribers/{subscriberId}/preferences","href":"/api-reference/subscribers/retrieve-subscriber-preferences"},{"title":"Update subscriber preferences","openapi":"PATCH /v2/subscribers/{subscriberId}/preferences","href":"/api-reference/subscribers/update-subscriber-preferences"},{"title":"Bulk update subscriber preferences","openapi":"PATCH /v2/subscribers/{subscriberId}/preferences/bulk","href":"/api-reference/subscribers/bulk-update-subscriber-preferences"}]},{"group":"Credentials","expanded":false,"pages":[{"title":"Update provider credentials","openapi":"PUT /v1/subscribers/{subscriberId}/credentials","href":"/api-reference/subscribers/update-provider-credentials"},{"title":"Upsert provider credentials","openapi":"PATCH /v1/subscribers/{subscriberId}/credentials","href":"/api-reference/subscribers/upsert-provider-credentials"},{"title":"Delete provider credentials","openapi":"DELETE /v1/subscribers/{subscriberId}/credentials/{providerId}","href":"/api-reference/subscribers/delete-provider-credentials"}]},{"group":"Notification state","expanded":false,"pages":[{"title":"Retrieve subscriber notifications","openapi":"GET /v1/subscribers/{subscriberId}/notifications/feed","href":"/api-reference/subscribers/retrieve-subscriber-notifications"},{"title":"Update notifications state","openapi":"POST /v1/subscribers/{subscriberId}/messages/mark-as","href":"/api-reference/subscribers/update-notifications-state"},{"title":"Update all notifications state","openapi":"POST /v1/subscribers/{subscriberId}/messages/mark-all","href":"/api-reference/subscribers/update-all-notifications-state"},{"title":"Update subscriber online status","openapi":"PATCH /v1/subscribers/{subscriberId}/online-status","href":"/api-reference/subscribers/update-subscriber-online-status"},{"title":"Retrieve unseen notifications count","openapi":"GET /v1/subscribers/{subscriberId}/notifications/unseen","href":"/api-reference/subscribers/retrieve-unseen-notifications-count"},{"title":"Update notification action status","openapi":"POST /v1/subscribers/{subscriberId}/messages/{messageId}/actions/{type}","href":"/api-reference/subscribers/update-notification-action-status"}]}]},{"group":"Inbox","expanded":false,"pages":[{"group":"Counts","expanded":false,"pages":[{"title":"Retrieve subscriber notifications count","openapi":"GET /v2/subscribers/{subscriberId}/notifications/count","href":"/api-reference/subscribers/retrieve-subscriber-notifications-count"}]},{"group":"Read \u0026 seen","expanded":false,"pages":[{"title":"Mark a notification as read","openapi":"PATCH /v2/subscribers/{subscriberId}/notifications/{notificationId}/read","href":"/api-reference/subscribers/mark-a-notification-as-read"},{"title":"Mark a notification as unread","openapi":"PATCH /v2/subscribers/{subscriberId}/notifications/{notificationId}/unread","href":"/api-reference/subscribers/mark-a-notification-as-unread"},{"title":"Mark all notifications as read","openapi":"POST /v2/subscribers/{subscriberId}/notifications/read","href":"/api-reference/subscribers/mark-all-notifications-as-read"},{"title":"Mark notifications as seen","openapi":"POST /v2/subscribers/{subscriberId}/notifications/seen","href":"/api-reference/subscribers/mark-notifications-as-seen"}]},{"group":"Snooze","expanded":false,"pages":[{"title":"Snooze a notification","openapi":"PATCH /v2/subscribers/{subscriberId}/notifications/{notificationId}/snooze","href":"/api-reference/subscribers/snooze-a-notification"},{"title":"Unsnooze a notification","openapi":"PATCH /v2/subscribers/{subscriberId}/notifications/{notificationId}/unsnooze","href":"/api-reference/subscribers/unsnooze-a-notification"}]},{"group":"Archive","expanded":false,"pages":[{"title":"Archive a notification","openapi":"PATCH /v2/subscribers/{subscriberId}/notifications/{notificationId}/archive","href":"/api-reference/subscribers/archive-a-notification"},{"title":"Unarchive a notification","openapi":"PATCH /v2/subscribers/{subscriberId}/notifications/{notificationId}/unarchive","href":"/api-reference/subscribers/unarchive-a-notification"},{"title":"Archive all notifications","openapi":"POST /v2/subscribers/{subscriberId}/notifications/archive","href":"/api-reference/subscribers/archive-all-notifications"},{"title":"Archive all read notifications","openapi":"POST /v2/subscribers/{subscriberId}/notifications/read-archive","href":"/api-reference/subscribers/archive-all-read-notifications"}]},{"group":"Delete","expanded":false,"pages":[{"title":"Delete a notification","openapi":"DELETE /v2/subscribers/{subscriberId}/notifications/{notificationId}","href":"/api-reference/subscribers/delete-a-notification"},{"title":"Delete all notifications","openapi":"POST /v2/subscribers/{subscriberId}/notifications/delete","href":"/api-reference/subscribers/delete-all-notifications"}]},{"group":"Actions","expanded":false,"pages":[{"title":"Complete a notification action","openapi":"PATCH /v2/subscribers/{subscriberId}/notifications/{notificationId}/actions/{actionType}/complete","href":"/api-reference/subscribers/complete-a-notification-action"},{"title":"Revert a notification action","openapi":"PATCH /v2/subscribers/{subscriberId}/notifications/{notificationId}/actions/{actionType}/revert","href":"/api-reference/subscribers/revert-a-notification-action"}]}]},{"group":"Topics","expanded":false,"pages":[{"title":"Topic schema","sidebarTitle":"Schema","href":"/api-reference/topics/topic-schema"},{"group":"Management","expanded":false,"pages":[{"title":"Create a topic","openapi":"POST /v2/topics","href":"/api-reference/topics/create-a-topic"},{"title":"Retrieve a topic","openapi":"GET /v2/topics/{topicKey}","href":"/api-reference/topics/retrieve-a-topic"},{"title":"Update a topic","openapi":"PATCH /v2/topics/{topicKey}","href":"/api-reference/topics/update-a-topic"},{"title":"Delete a topic","openapi":"DELETE /v2/topics/{topicKey}","href":"/api-reference/topics/delete-a-topic"},{"title":"List all topics","openapi":"GET /v2/topics","href":"/api-reference/topics/list-all-topics"}]},{"group":"Subscriptions","expanded":false,"pages":[{"title":"Create topic subscriptions","openapi":"POST /v2/topics/{topicKey}/subscriptions","href":"/api-reference/topics/create-topic-subscriptions"},{"title":"Delete topic subscriptions","openapi":"DELETE /v2/topics/{topicKey}/subscriptions","href":"/api-reference/topics/delete-topic-subscriptions"},{"title":"Update a topic subscription","openapi":"PATCH /v2/topics/{topicKey}/subscriptions/{identifier}","href":"/api-reference/topics/update-a-topic-subscription"},{"title":"List topic subscriptions","openapi":"GET /v2/topics/{topicKey}/subscriptions","href":"/api-reference/topics/list-topic-subscriptions"},{"title":"Check topic subscriber","openapi":"GET /v1/topics/{topicKey}/subscribers/{externalSubscriberId}","href":"/api-reference/topics/check-topic-subscriber"},{"title":"Retrieve a topic subscription","openapi":"GET /v2/topics/{topicKey}/subscriptions/{identifier}","href":"/api-reference/topics/retrieve-a-topic-subscription"}]}]},{"group":"Contexts","expanded":false,"pages":[{"title":"Context schema","sidebarTitle":"Schema","href":"/api-reference/contexts/context-schema"},{"title":"Create a context","openapi":"POST /v2/contexts","href":"/api-reference/contexts/create-a-context"},{"title":"Retrieve a context","openapi":"GET /v2/contexts/{type}/{id}","href":"/api-reference/contexts/retrieve-a-context"},{"title":"Update a context","openapi":"PATCH /v2/contexts/{type}/{id}","href":"/api-reference/contexts/update-a-context"},{"title":"Delete a context","openapi":"DELETE /v2/contexts/{type}/{id}","href":"/api-reference/contexts/delete-a-context"},{"title":"List all contexts","openapi":"GET /v2/contexts","href":"/api-reference/contexts/list-all-contexts"}]},{"group":"Channel Connections","expanded":false,"pages":[{"title":"Create a channel connection","openapi":"POST /v1/channel-connections","href":"/api-reference/channel-connections/create-a-channel-connection"},{"title":"Retrieve a channel connection","openapi":"GET /v1/channel-connections/{identifier}","href":"/api-reference/channel-connections/retrieve-a-channel-connection"},{"title":"Update a channel connection","openapi":"PATCH /v1/channel-connections/{identifier}","href":"/api-reference/channel-connections/update-a-channel-connection"},{"title":"Delete a channel connection","openapi":"DELETE /v1/channel-connections/{identifier}","href":"/api-reference/channel-connections/delete-a-channel-connection"},{"title":"List all channel connections","openapi":"GET /v1/channel-connections","href":"/api-reference/channel-connections/list-all-channel-connections"}]},{"group":"Channel Endpoints","expanded":false,"pages":[{"title":"Create a channel endpoint","openapi":"POST /v1/channel-endpoints","href":"/api-reference/channel-endpoints/create-a-channel-endpoint"},{"title":"Retrieve a channel endpoint","openapi":"GET /v1/channel-endpoints/{identifier}","href":"/api-reference/channel-endpoints/retrieve-a-channel-endpoint"},{"title":"Update a channel endpoint","openapi":"PATCH /v1/channel-endpoints/{identifier}","href":"/api-reference/channel-endpoints/update-a-channel-endpoint"},{"title":"Delete a channel endpoint","openapi":"DELETE /v1/channel-endpoints/{identifier}","href":"/api-reference/channel-endpoints/delete-a-channel-endpoint"},{"title":"List all channel endpoints","openapi":"GET /v1/channel-endpoints","href":"/api-reference/channel-endpoints/list-all-channel-endpoints"}]}]},{"group":"Workflows \u0026 content","icon":"git-branch","pages":[{"group":"Workflows","expanded":false,"pages":[{"title":"Workflow schema","sidebarTitle":"Schema","href":"/api-reference/workflows/workflow-schema"},{"title":"Create a workflow","openapi":"POST /v2/workflows","href":"/api-reference/workflows/create-a-workflow"},{"title":"Retrieve a workflow","openapi":"GET /v2/workflows/{workflowId}","href":"/api-reference/workflows/retrieve-a-workflow"},{"title":"Update a workflow","openapi":"PUT /v2/workflows/{workflowId}","href":"/api-reference/workflows/update-a-workflow"},{"title":"Delete a workflow","openapi":"DELETE /v2/workflows/{workflowId}","href":"/api-reference/workflows/delete-a-workflow"},{"title":"List all workflows","openapi":"GET /v2/workflows","href":"/api-reference/workflows/list-all-workflows"},{"title":"Sync a workflow","openapi":"PUT /v2/workflows/{workflowId}/sync","href":"/api-reference/workflows/sync-a-workflow"},{"title":"Retrieve workflow step","openapi":"GET /v2/workflows/{workflowId}/steps/{stepId}","href":"/api-reference/workflows/retrieve-workflow-step"},{"title":"Generate a step preview","openapi":"POST /v2/workflows/{workflowId}/step/{stepId}/preview","href":"/api-reference/workflows/generate-a-step-preview"}]},{"group":"Translations","expanded":false,"pages":[{"title":"Create a translation","openapi":"POST /v2/translations","href":"/api-reference/translations/create-a-translation"},{"title":"Retrieve a translation","openapi":"GET /v2/translations/{resourceType}/{resourceId}/{locale}","href":"/api-reference/translations/retrieve-a-translation"},{"title":"Delete a translation","openapi":"DELETE /v2/translations/{resourceType}/{resourceId}/{locale}","href":"/api-reference/translations/delete-a-translation"},{"title":"Retrieve a translation group","openapi":"GET /v2/translations/group/{resourceType}/{resourceId}","href":"/api-reference/translations/retrieve-a-translation-group"},{"title":"Delete a translation group","openapi":"DELETE /v2/translations/{resourceType}/{resourceId}","href":"/api-reference/translations/delete-a-translation-group"},{"title":"Import master translations JSON","openapi":"POST /v2/translations/master-json","href":"/api-reference/translations/import-master-translations-json"},{"title":"Retrieve master translations JSON","openapi":"GET /v2/translations/master-json","href":"/api-reference/translations/retrieve-master-translations-json"},{"title":"Upload master translations JSON file","openapi":"POST /v2/translations/master-json/upload","href":"/api-reference/translations/upload-master-translations-json-file"},{"title":"Upload translation files","openapi":"POST /v2/translations/upload","href":"/api-reference/translations/upload-translation-files"}]},{"group":"Layouts","expanded":false,"pages":[{"title":"Create a layout","openapi":"POST /v2/layouts","href":"/api-reference/layouts/create-a-layout"},{"title":"Delete a layout","openapi":"DELETE /v2/layouts/{layoutId}","href":"/api-reference/layouts/delete-a-layout"},{"title":"Duplicate a layout","openapi":"POST /v2/layouts/{layoutId}/duplicate","href":"/api-reference/layouts/duplicate-a-layout"},{"title":"Generate layout preview","openapi":"POST /v2/layouts/{layoutId}/preview","href":"/api-reference/layouts/generate-layout-preview"},{"title":"Get layout usage","openapi":"GET /v2/layouts/{layoutId}/usage","href":"/api-reference/layouts/get-layout-usage"},{"title":"List all layouts","openapi":"GET /v2/layouts","href":"/api-reference/layouts/list-all-layouts"},{"title":"Retrieve a layout","openapi":"GET /v2/layouts/{layoutId}","href":"/api-reference/layouts/retrieve-a-layout"},{"title":"Update a layout","openapi":"PUT /v2/layouts/{layoutId}","href":"/api-reference/layouts/update-a-layout"}]}]},{"group":"Platform \u0026 channels","icon":"settings","pages":[{"group":"Environments","expanded":false,"pages":[{"title":"Environment schema","sidebarTitle":"Schema","href":"/api-reference/environments/environment-schema"},{"title":"Create an environment","openapi":"POST /v1/environments","href":"/api-reference/environments/create-an-environment"},{"title":"Update an environment","openapi":"PUT /v1/environments/{environmentId}","href":"/api-reference/environments/update-an-environment"},{"title":"Delete an environment","openapi":"DELETE /v1/environments/{environmentId}","href":"/api-reference/environments/delete-an-environment"},{"title":"List all environments","openapi":"GET /v1/environments","href":"/api-reference/environments/list-all-environments"},{"title":"List environment tags","openapi":"GET /v2/environments/{environmentId}/tags","href":"/api-reference/environments/list-environment-tags"},{"title":"Compare resources between environments","openapi":"POST /v2/environments/{targetEnvironmentId}/diff","href":"/api-reference/environments/compare-resources-between-environments"},{"title":"Publish resources to target environment","openapi":"POST /v2/environments/{targetEnvironmentId}/publish","href":"/api-reference/environments/publish-resources-to-target-environment"}]},{"group":"Environment Variables","expanded":false,"pages":[{"title":"Environment variable schema","sidebarTitle":"Schema","href":"/api-reference/environment-variables/environment-variable-schema"},{"title":"Create a variable","openapi":"POST /v1/environment-variables","href":"/api-reference/environment-variables/create-a-variable"},{"title":"Retrieve a variable","openapi":"GET /v1/environment-variables/{variableKey}","href":"/api-reference/environment-variables/retrieve-a-variable"},{"title":"Update a variable","openapi":"PATCH /v1/environment-variables/{variableKey}","href":"/api-reference/environment-variables/update-a-variable"},{"title":"Delete a variable","openapi":"DELETE /v1/environment-variables/{variableKey}","href":"/api-reference/environment-variables/delete-a-variable"},{"title":"List all variables","openapi":"GET /v1/environment-variables","href":"/api-reference/environment-variables/list-all-variables"},{"title":"Retrieve a variable usage","openapi":"GET /v1/environment-variables/{variableKey}/usage","href":"/api-reference/environment-variables/retrieve-a-variable-usage"}]},{"group":"Integrations","expanded":false,"pages":[{"title":"Integration schema","sidebarTitle":"Schema","href":"/api-reference/integrations/integration-schema"},{"title":"Create an integration","openapi":"POST /v1/integrations","href":"/api-reference/integrations/create-an-integration"},{"title":"Update an integration","openapi":"PUT /v1/integrations/{integrationId}","href":"/api-reference/integrations/update-an-integration"},{"title":"Delete an integration","openapi":"DELETE /v1/integrations/{integrationId}","href":"/api-reference/integrations/delete-an-integration"},{"title":"List all integrations","openapi":"GET /v1/integrations","href":"/api-reference/integrations/list-all-integrations"},{"title":"List active integrations","openapi":"GET /v1/integrations/active","href":"/api-reference/integrations/list-active-integrations"},{"title":"Update integration as primary","openapi":"POST /v1/integrations/{integrationId}/set-primary","href":"/api-reference/integrations/update-integration-as-primary"},{"title":"Generate chat OAuth URL","openapi":"POST /v1/integrations/chat/oauth","href":"/api-reference/integrations/generate-chat-oauth-url"},{"title":"Auto-configure an integration for inbound webhooks","openapi":"POST /v1/integrations/{integrationId}/auto-configure","href":"/api-reference/integrations/auto-configure-an-integration-for-inbound-webhooks"}]}]}]},{"tab":"Resources","menu":[{"item":"Guides","pages":[{"title":"Guides","href":"/guides"}]},{"item":"Framework","pages":[{"title":"Framework","href":"/framework"}]},{"item":"Community","pages":[{"title":"Community","href":"/community"}]}],"pages":[{"title":"Resources","href":"/guides"}]}]},"title":"Bulk trigger event - Novu","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","b0f84f53ff","2b790eda92","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-R3M_BF4L.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}