{"templateId":"openapi_docs","versions":[],"sharedDataIds":{"openAPIDocsStore":"oas-API Docs/@2023-11-29/api-public.yaml","sidebar":"sidebar-sidebar.yaml__api-docs_api-public"},"props":{"definitionId":"API Docs/@2023-11-29/api-public.yaml","dynamicMarkdocComponents":[],"baseSlug":"/api-docs/api-public","seo":{"title":"Notification Types","description":"This object allows you to create custom `Notification Types` which will create\n`interaction` instances (such as emails, text messages, etc.) automatically when case conditions are met. For example,\nwhen a new `bankruptcy` case is `initiated`, the system can automatically send an email notification\nand ask the borrower to provide supporting documents.\n\nThe conditions are set in the following way. There are two triggers and one condition fields that you can configure:\n1. `onStatus` - triggered based on the case status.\n2. `onOutcome` - triggered based on the case outcome.\n3. `onCondition` - condition(s) based on case fields values.\n\nYou must provide at least one trigger, `onStatus` or `onOutcome`, when creating a new `Notification Type` object.\n\nFew examples:\n- `onStatus=processing`, `onOutcome=null`, `onCondition=null` - the `interaction`\ninstance will be created when the case status is changed to `processing`.\n- `onStatus=completed`, `onOutcome=approved`, `onCondition=null` - the `interaction`\ninstance will be created when the case status is changed to `completed` and the outcome is `approved`.\n\n`Notification Types` must be associated with `Case Types`. A `Notification Type` object can\nbe associated with multiple `Case Types`.\n"},"itemId":"notification-types","disableAutoScroll":true,"metadata":{},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"headers":{"accept":"*/*","accept-encoding":"br,gzip","host":"peach-docs-dev.redocly.app","user-agent":"Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)","via":"2.0 Caddy, 2.0 a71dc86d67780d7478c72e1b147b8a32.cloudfront.net (CloudFront), 1.1 Caddy","x-amz-cf-id":"DqhtykECIgAyhAH2yAwWRDLaBWXEWsKVLSfMR8WbYJ4NOtFR51aEZQ==","x-forwarded-for":"216.73.216.253, 54.156.60.142, 64.252.68.39","x-forwarded-host":"peach-docs-dev.redocly.app","x-forwarded-proto":"https","x-request-id":"cds-cb4b5814-5392-43af-88dc-d8cd86152d11"},"remoteAddr":{"hostname":"::ffff:10.0.1.185","port":58174},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"develop"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/api-docs/api-public/notification-types","userData":{"isAuthenticated":false,"teams":["anonymous"]}}