> For the complete documentation index, see [llms.txt](https://docs.codemash.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.codemash.io/api-reference/payments/triggers/save-payments-trigger.md).

# Save Payments Trigger

A **payments trigger** runs an action automatically on order events — for example sending a receipt email when an order is paid. It fires on `OnOrderCreated`, `OnOrderPaid`, or `OnWebhookCallReceived`; the optional `integrations` and `events` fields narrow which payment integrations and webhook events it reacts to.

This endpoint creates the trigger (or updates it when you pass an existing `triggerId`); the response returns its id.

## POST /api/SavePaymentsTrigger

>

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"servers":[{"url":"https://hub.norbix.ai"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","description":"JWT Bearer Authorization","scheme":"Bearer","bearerFormat":"JWT"}},"schemas":{"SaveTriggerRequest":{"title":"SaveTriggerRequest","type":"object","properties":{"type":{"$ref":"#/components/schemas/TriggerType"},"triggerId":{"type":"string","nullable":true},"name":{"type":"string"},"description":{"type":"string","nullable":true},"isEnabled":{"type":"boolean"},"preExecuteCode":{"type":"string","nullable":true},"action":{"$ref":"#/components/schemas/TriggerActionDto"}},"description":"SaveTriggerRequest"},"TriggerType":{"enum":["Membership","Schema","Files","Payments"],"type":"string"},"TriggerActionDto":{"title":"TriggerActionDto","type":"object","properties":{"integrationId":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/TriggerActionType"}},"description":"TriggerActionDto"},"TriggerActionType":{"enum":["Code","Push","Sms","Email","WebhookCall","SseCall","Marketplace"],"type":"string"},"SavePaymentsTrigger":{"title":"SavePaymentsTrigger","required":["version","projectId"],"type":"object","properties":{"correlationId":{"type":"string","description":"CorrelationId for each request","nullable":true},"cultureCode":{"type":"string","description":"Specify culture code when your response from the API should be localised. E.g.: en","nullable":true},"timeZoneId":{"type":"string","description":"TimeZone","nullable":true},"version":{"type":"string","description":"The CodeMash API version used to fetch data from the API. If not specified, the last version will be used.  E.g.: v3","nullable":true},"env":{"type":"string","description":"Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.","nullable":true},"projectId":{"type":"string","description":"ID of your project. Can be passed in a header as norbix-project-id."},"trigger":{"$ref":"#/components/schemas/SaveTriggerRequest"}},"description":"SavePaymentsTrigger"},"IdResponse":{"required":["responseStatus"],"type":"object","properties":{"responseStatus":{"$ref":"#/components/schemas/CodeMashResponseStatus"},"id":{"type":"string","nullable":true},"status":{"type":"string","nullable":true}},"additionalProperties":false},"CodeMashResponseStatus":{"title":"CodeMashResponseStatus","type":"object","properties":{"isSuccess":{"type":"boolean"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDto"},"nullable":true},"success":{"$ref":"#/components/schemas/CodeMashResponseStatus"}},"description":"CodeMashResponseStatus"},"ErrorDto":{"title":"ErrorDto","type":"object","properties":{"message":{"type":"string"},"errorCode":{"type":"string","nullable":true},"context":{"title":"Dictionary<String,String>","type":"object","additionalProperties":{"type":"string","nullable":true},"nullable":true},"stackTrace":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDto"},"nullable":true}},"description":"ErrorDto"}}},"paths":{"/api/SavePaymentsTrigger":{"post":{"tags":["Account"],"requestBody":{"content":{"multipart/form-data":{"schema":{"title":"SavePaymentsTrigger","required":["version","projectId"],"type":"object","properties":{"correlationId":{"type":"string","description":"CorrelationId for each request","nullable":true},"cultureCode":{"type":"string","description":"Specify culture code when your response from the API should be localised. E.g.: en","nullable":true},"timeZoneId":{"type":"string","description":"TimeZone","nullable":true},"version":{"type":"string","description":"The CodeMash API version used to fetch data from the API. If not specified, the last version will be used.  E.g.: v3","nullable":true},"env":{"type":"string","description":"Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.","nullable":true},"projectId":{"type":"string","description":"ID of your project. Can be passed in a header as norbix-project-id."},"trigger":{"$ref":"#/components/schemas/SaveTriggerRequest"}},"description":"SavePaymentsTrigger"},"encoding":{"correlationId":{"style":"form","explode":false},"cultureCode":{"style":"form","explode":false},"timeZoneId":{"style":"form","explode":false},"version":{"style":"form","explode":false},"env":{"style":"form","explode":false},"projectId":{"style":"form","explode":false},"trigger":{"style":"form","explode":false}}},"application/json":{"schema":{"$ref":"#/components/schemas/SavePaymentsTrigger"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdResponse"}}}}}}}}}
```

## Request body

The request body is **polymorphic**. It is one of the `SaveTriggerRequest` types, chosen by the `type` field (`Membership`, `Schema`, `Payment`, or `Files`). For a payments trigger, `type` is `Payments` and the body is a **`PaymentTriggerRequest`** — you do not send the abstract base directly:

## The PaymentTriggerRequest object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"PaymentTriggerRequest":{"title":"PaymentTriggerRequest","type":"object","allOf":[{"$ref":"#/components/schemas/SaveTriggerRequest"}],"properties":{"type":{"$ref":"#/components/schemas/TriggerType"},"when":{"$ref":"#/components/schemas/PaymentTriggerType"},"integrations":{"type":"array","items":{"type":"string"},"nullable":true},"events":{"type":"array","items":{"type":"string"},"nullable":true},"triggerId":{"type":"string","nullable":true},"name":{"type":"string"},"description":{"type":"string","nullable":true},"isEnabled":{"type":"boolean"},"preExecuteCode":{"type":"string","nullable":true},"action":{"$ref":"#/components/schemas/TriggerActionDto"}},"description":"PaymentTriggerRequest"},"SaveTriggerRequest":{"title":"SaveTriggerRequest","type":"object","properties":{"type":{"$ref":"#/components/schemas/TriggerType"},"triggerId":{"type":"string","nullable":true},"name":{"type":"string"},"description":{"type":"string","nullable":true},"isEnabled":{"type":"boolean"},"preExecuteCode":{"type":"string","nullable":true},"action":{"$ref":"#/components/schemas/TriggerActionDto"}},"description":"SaveTriggerRequest"},"TriggerType":{"enum":["Membership","Schema","Files","Payments"],"type":"string"},"TriggerActionDto":{"title":"TriggerActionDto","type":"object","properties":{"integrationId":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/TriggerActionType"}},"description":"TriggerActionDto"},"TriggerActionType":{"enum":["Code","Push","Sms","Email","WebhookCall","SseCall","Marketplace"],"type":"string"},"PaymentTriggerType":{"enum":["OnOrderCreated","OnOrderPaid","OnWebhookCallReceived"],"type":"string"}}}}
```

`when` selects which event fires the trigger (see the `PaymentTriggerType` values). `action` is the action to run when it fires — described next.

## Step 1 — pick the action

Every trigger runs exactly one **action**, chosen by `action.type`. Each action targets a channel and carries a `deliverySettings` object shaped for that channel:

| `action.type` | Action schema                 | Delivery settings                  |
| ------------- | ----------------------------- | ---------------------------------- |
| `email`       | `TriggerActionEmailDto`       | `EmailCampaignDeliverySettingsDto` |
| `push`        | `TriggerActionPushDto`        | `PushCampaignDeliverySettingsDto`  |
| `webhookcall` | `TriggerActionWebhookDto`     | `WebhookDeliverySettingsDto`       |
| `code`        | `TriggerActionCodeDto`        | `CodeDeliverySettingsDto`          |
| `sms`         | `TriggerActionSmsDto`         | `SmsCampaignDeliverySettingsDto`   |
| `ssecall`     | `TriggerActionSseDto`         | `SseDeliverySettingsDto`           |
| `marketplace` | `TriggerActionMarketplaceDto` | — (uses `functionId` + `payload`)  |

Pass one of these action objects:

## The TriggerActionEmailDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"TriggerActionEmailDto":{"title":"TriggerActionEmailDto","type":"object","allOf":[{"$ref":"#/components/schemas/TriggerActionDto"}],"properties":{"integrationId":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/TriggerActionType"},"deliverySettings":{"$ref":"#/components/schemas/EmailCampaignDeliverySettingsDto"},"templateId":{"type":"string"}},"description":"TriggerActionEmailDto"},"TriggerActionDto":{"title":"TriggerActionDto","type":"object","properties":{"integrationId":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/TriggerActionType"}},"description":"TriggerActionDto"},"TriggerActionType":{"enum":["Code","Push","Sms","Email","WebhookCall","SseCall","Marketplace"],"type":"string"},"EmailCampaignDeliverySettingsDto":{"title":"EmailCampaignDeliverySettingsDto","type":"object","properties":{"recipientsSourceType":{"$ref":"#/components/schemas/EmailCampaignRecipientsSourceTypes"},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"campaignTime":{"type":"integer","format":"int64","nullable":true},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"}},"description":"EmailCampaignDeliverySettingsDto"},"EmailCampaignRecipientsSourceTypes":{"enum":["AllUsers","SpecifiedUsers","AccountUsers","Email","Collection"],"type":"string"},"RespectTimeZoneSettings":{"enum":["1 (RespectToLastLoginZone)","2 (RespectToRegistrationZone)","4 (RespectToRegistrationProjectZone)"],"type":"integer","format":"int32"}}}}
```

## The TriggerActionPushDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"TriggerActionPushDto":{"title":"TriggerActionPushDto","type":"object","allOf":[{"$ref":"#/components/schemas/TriggerActionDto"}],"properties":{"integrationId":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/TriggerActionType"},"deliverySettings":{"$ref":"#/components/schemas/PushCampaignDeliverySettingsDto"},"templateId":{"type":"string"}},"description":"TriggerActionPushDto"},"TriggerActionDto":{"title":"TriggerActionDto","type":"object","properties":{"integrationId":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/TriggerActionType"}},"description":"TriggerActionDto"},"TriggerActionType":{"enum":["Code","Push","Sms","Email","WebhookCall","SseCall","Marketplace"],"type":"string"},"PushCampaignDeliverySettingsDto":{"title":"PushCampaignDeliverySettingsDto","type":"object","properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/PushCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"}},"description":"PushCampaignDeliverySettingsDto"},"PushCampaignRecipientsSourceTypes":{"enum":["AllUsers","SpecifiedUsers","Collection","Devices","AccountUsers"],"type":"string"},"RespectTimeZoneSettings":{"enum":["1 (RespectToLastLoginZone)","2 (RespectToRegistrationZone)","4 (RespectToRegistrationProjectZone)"],"type":"integer","format":"int32"}}}}
```

## The TriggerActionSmsDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"TriggerActionSmsDto":{"title":"TriggerActionSmsDto","type":"object","allOf":[{"$ref":"#/components/schemas/TriggerActionDto"}],"properties":{"integrationId":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/TriggerActionType"},"deliverySettings":{"$ref":"#/components/schemas/SmsCampaignDeliverySettingsDto"},"templateId":{"type":"string"}},"description":"TriggerActionSmsDto"},"TriggerActionDto":{"title":"TriggerActionDto","type":"object","properties":{"integrationId":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/TriggerActionType"}},"description":"TriggerActionDto"},"TriggerActionType":{"enum":["Code","Push","Sms","Email","WebhookCall","SseCall","Marketplace"],"type":"string"},"SmsCampaignDeliverySettingsDto":{"title":"SmsCampaignDeliverySettingsDto","type":"object","properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/SmsCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"}},"description":"SmsCampaignDeliverySettingsDto"},"SmsCampaignRecipientsSourceTypes":{"enum":["AllUsers","SpecifiedUsers","AccountUsers","PhoneNumbers","Collection"],"type":"string"},"RespectTimeZoneSettings":{"enum":["1 (RespectToLastLoginZone)","2 (RespectToRegistrationZone)","4 (RespectToRegistrationProjectZone)"],"type":"integer","format":"int32"}}}}
```

## The TriggerActionWebhookDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"TriggerActionWebhookDto":{"title":"TriggerActionWebhookDto","type":"object","allOf":[{"$ref":"#/components/schemas/TriggerActionDto"}],"properties":{"integrationId":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/TriggerActionType"},"deliverySettings":{"$ref":"#/components/schemas/WebhookDeliverySettingsDto"}},"description":"TriggerActionWebhookDto"},"TriggerActionDto":{"title":"TriggerActionDto","type":"object","properties":{"integrationId":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/TriggerActionType"}},"description":"TriggerActionDto"},"TriggerActionType":{"enum":["Code","Push","Sms","Email","WebhookCall","SseCall","Marketplace"],"type":"string"},"WebhookDeliverySettingsDto":{"title":"WebhookDeliverySettingsDto","type":"object","properties":{"contentType":{"type":"string","nullable":true},"destinationIds":{"type":"array","items":{"type":"string"},"nullable":true},"eventName":{"type":"string","nullable":true},"includeRawPayload":{"type":"boolean"},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"}},"description":"WebhookDeliverySettingsDto"}}}}
```

## The TriggerActionCodeDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"TriggerActionCodeDto":{"title":"TriggerActionCodeDto","type":"object","allOf":[{"$ref":"#/components/schemas/TriggerActionDto"}],"properties":{"integrationId":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/TriggerActionType"},"deliverySettings":{"$ref":"#/components/schemas/CodeDeliverySettingsDto"},"functionId":{"type":"string"}},"description":"TriggerActionCodeDto"},"TriggerActionDto":{"title":"TriggerActionDto","type":"object","properties":{"integrationId":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/TriggerActionType"}},"description":"TriggerActionDto"},"TriggerActionType":{"enum":["Code","Push","Sms","Email","WebhookCall","SseCall","Marketplace"],"type":"string"},"CodeDeliverySettingsDto":{"title":"CodeDeliverySettingsDto","type":"object","properties":{"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"}},"description":"CodeDeliverySettingsDto"}}}}
```

## The TriggerActionSseDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"TriggerActionSseDto":{"title":"TriggerActionSseDto","type":"object","allOf":[{"$ref":"#/components/schemas/TriggerActionDto"}],"properties":{"integrationId":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/TriggerActionType"},"deliverySettings":{"$ref":"#/components/schemas/SseDeliverySettingsDto"}},"description":"TriggerActionSseDto"},"TriggerActionDto":{"title":"TriggerActionDto","type":"object","properties":{"integrationId":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/TriggerActionType"}},"description":"TriggerActionDto"},"TriggerActionType":{"enum":["Code","Push","Sms","Email","WebhookCall","SseCall","Marketplace"],"type":"string"},"SseDeliverySettingsDto":{"title":"SseDeliverySettingsDto","type":"object","properties":{"audience":{"type":"string"},"eventName":{"type":"string","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"payloadTemplate":{"type":"string","nullable":true},"payloadType":{"type":"string","nullable":true},"persist":{"type":"boolean"},"userAuthIds":{"$ref":"#/components/schemas/HashSet<String>"}},"description":"SseDeliverySettingsDto"}}}}
```

## The TriggerActionMarketplaceDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"TriggerActionMarketplaceDto":{"title":"TriggerActionMarketplaceDto","type":"object","allOf":[{"$ref":"#/components/schemas/TriggerActionDto"}],"properties":{"integrationId":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/TriggerActionType"},"functionId":{"type":"string"},"payload":{"title":"Dictionary<String,String>","type":"object","additionalProperties":{"type":"string","nullable":true},"nullable":true}},"description":"TriggerActionMarketplaceDto"},"TriggerActionDto":{"title":"TriggerActionDto","type":"object","properties":{"integrationId":{"type":"string","nullable":true},"type":{"$ref":"#/components/schemas/TriggerActionType"}},"description":"TriggerActionDto"},"TriggerActionType":{"enum":["Code","Push","Sms","Email","WebhookCall","SseCall","Marketplace"],"type":"string"}}}}
```

## Step 2 — pick the delivery settings

The action's `deliverySettings` controls **who** receives the message and **when**. For the messaging channels (email, push, SMS) this object is **itself polymorphic**: the concrete shape is chosen by its `recipientsSourceType` field. Pick the one that matches your audience.

### Email delivery — `EmailCampaignDeliverySettingsDto`

| `recipientsSourceType` | Sends to                           | Concrete shape                                |
| ---------------------- | ---------------------------------- | --------------------------------------------- |
| `AllUsers`             | every user in the project          | `EmailToAllUsersDeliverySettingsDto`          |
| `AccountUsers`         | users on the account               | `EmailToAccountUsersDeliverySettingsDto`      |
| `SpecifiedUsers`       | a list of user ids                 | `EmailToUsersDeliverySettingsDto`             |
| `Email`                | raw email addresses                | `EmailToEmailAddressesDeliverySettingsDto`    |
| `Collection`           | records from a database collection | `EmailToCollectionRecordsDeliverySettingsDto` |

## The EmailCampaignDeliverySettingsDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"EmailCampaignDeliverySettingsDto":{"title":"EmailCampaignDeliverySettingsDto","type":"object","properties":{"recipientsSourceType":{"$ref":"#/components/schemas/EmailCampaignRecipientsSourceTypes"},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"campaignTime":{"type":"integer","format":"int64","nullable":true},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"}},"description":"EmailCampaignDeliverySettingsDto"},"EmailCampaignRecipientsSourceTypes":{"enum":["AllUsers","SpecifiedUsers","AccountUsers","Email","Collection"],"type":"string"},"RespectTimeZoneSettings":{"enum":["1 (RespectToLastLoginZone)","2 (RespectToRegistrationZone)","4 (RespectToRegistrationProjectZone)"],"type":"integer","format":"int32"}}}}
```

## The EmailToAllUsersDeliverySettingsDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"EmailToAllUsersDeliverySettingsDto":{"title":"EmailToAllUsersDeliverySettingsDto","type":"object","allOf":[{"$ref":"#/components/schemas/EmailCampaignDeliverySettingsDto"}],"properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/EmailCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"},"rolesNames":{"$ref":"#/components/schemas/HashSet<String>"},"userTags":{"$ref":"#/components/schemas/HashSet<String>"}},"description":"EmailToAllUsersDeliverySettingsDto"},"EmailCampaignDeliverySettingsDto":{"title":"EmailCampaignDeliverySettingsDto","type":"object","properties":{"recipientsSourceType":{"$ref":"#/components/schemas/EmailCampaignRecipientsSourceTypes"},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"campaignTime":{"type":"integer","format":"int64","nullable":true},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"}},"description":"EmailCampaignDeliverySettingsDto"},"EmailCampaignRecipientsSourceTypes":{"enum":["AllUsers","SpecifiedUsers","AccountUsers","Email","Collection"],"type":"string"},"RespectTimeZoneSettings":{"enum":["1 (RespectToLastLoginZone)","2 (RespectToRegistrationZone)","4 (RespectToRegistrationProjectZone)"],"type":"integer","format":"int32"}}}}
```

## The EmailToAccountUsersDeliverySettingsDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"EmailToAccountUsersDeliverySettingsDto":{"title":"EmailToAccountUsersDeliverySettingsDto","type":"object","allOf":[{"$ref":"#/components/schemas/EmailCampaignDeliverySettingsDto"}],"properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/EmailCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"},"singleEmailStrategy":{"type":"boolean"},"userBcc":{"$ref":"#/components/schemas/HashSet<String>"},"userCc":{"$ref":"#/components/schemas/HashSet<String>"},"userRecipients":{"$ref":"#/components/schemas/HashSet<String>"}},"description":"EmailToAccountUsersDeliverySettingsDto"},"EmailCampaignDeliverySettingsDto":{"title":"EmailCampaignDeliverySettingsDto","type":"object","properties":{"recipientsSourceType":{"$ref":"#/components/schemas/EmailCampaignRecipientsSourceTypes"},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"campaignTime":{"type":"integer","format":"int64","nullable":true},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"}},"description":"EmailCampaignDeliverySettingsDto"},"EmailCampaignRecipientsSourceTypes":{"enum":["AllUsers","SpecifiedUsers","AccountUsers","Email","Collection"],"type":"string"},"RespectTimeZoneSettings":{"enum":["1 (RespectToLastLoginZone)","2 (RespectToRegistrationZone)","4 (RespectToRegistrationProjectZone)"],"type":"integer","format":"int32"}}}}
```

## The EmailToUsersDeliverySettingsDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"EmailToUsersDeliverySettingsDto":{"title":"EmailToUsersDeliverySettingsDto","type":"object","allOf":[{"$ref":"#/components/schemas/EmailCampaignDeliverySettingsDto"}],"properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/EmailCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"},"singleEmailStrategy":{"type":"boolean"},"userBcc":{"$ref":"#/components/schemas/HashSet<String>"},"userCc":{"$ref":"#/components/schemas/HashSet<String>"},"userRecipients":{"$ref":"#/components/schemas/HashSet<String>"}},"description":"EmailToUsersDeliverySettingsDto"},"EmailCampaignDeliverySettingsDto":{"title":"EmailCampaignDeliverySettingsDto","type":"object","properties":{"recipientsSourceType":{"$ref":"#/components/schemas/EmailCampaignRecipientsSourceTypes"},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"campaignTime":{"type":"integer","format":"int64","nullable":true},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"}},"description":"EmailCampaignDeliverySettingsDto"},"EmailCampaignRecipientsSourceTypes":{"enum":["AllUsers","SpecifiedUsers","AccountUsers","Email","Collection"],"type":"string"},"RespectTimeZoneSettings":{"enum":["1 (RespectToLastLoginZone)","2 (RespectToRegistrationZone)","4 (RespectToRegistrationProjectZone)"],"type":"integer","format":"int32"}}}}
```

## The EmailToEmailAddressesDeliverySettingsDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"EmailToEmailAddressesDeliverySettingsDto":{"title":"EmailToEmailAddressesDeliverySettingsDto","type":"object","allOf":[{"$ref":"#/components/schemas/EmailCampaignDeliverySettingsDto"}],"properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/EmailCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"},"recipients":{"$ref":"#/components/schemas/HashSet<String>"},"recipientsBcc":{"$ref":"#/components/schemas/HashSet<String>"},"recipientsCc":{"$ref":"#/components/schemas/HashSet<String>"},"singleEmailStrategy":{"type":"boolean"}},"description":"EmailToEmailAddressesDeliverySettingsDto"},"EmailCampaignDeliverySettingsDto":{"title":"EmailCampaignDeliverySettingsDto","type":"object","properties":{"recipientsSourceType":{"$ref":"#/components/schemas/EmailCampaignRecipientsSourceTypes"},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"campaignTime":{"type":"integer","format":"int64","nullable":true},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"}},"description":"EmailCampaignDeliverySettingsDto"},"EmailCampaignRecipientsSourceTypes":{"enum":["AllUsers","SpecifiedUsers","AccountUsers","Email","Collection"],"type":"string"},"RespectTimeZoneSettings":{"enum":["1 (RespectToLastLoginZone)","2 (RespectToRegistrationZone)","4 (RespectToRegistrationProjectZone)"],"type":"integer","format":"int32"}}}}
```

## The EmailToCollectionRecordsDeliverySettingsDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"EmailToCollectionRecordsDeliverySettingsDto":{"title":"EmailToCollectionRecordsDeliverySettingsDto","type":"object","allOf":[{"$ref":"#/components/schemas/EmailCampaignDeliverySettingsDto"}],"properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/EmailCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"},"fields":{"$ref":"#/components/schemas/HashSet<String>"},"fieldType":{"$ref":"#/components/schemas/CollectionEmailCampaignRecipientField"},"languages":{"$ref":"#/components/schemas/HashSet<String>"},"roleNames":{"$ref":"#/components/schemas/HashSet<String>"},"schemaName":{"type":"string"}},"description":"EmailToCollectionRecordsDeliverySettingsDto"},"EmailCampaignDeliverySettingsDto":{"title":"EmailCampaignDeliverySettingsDto","type":"object","properties":{"recipientsSourceType":{"$ref":"#/components/schemas/EmailCampaignRecipientsSourceTypes"},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"campaignTime":{"type":"integer","format":"int64","nullable":true},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"}},"description":"EmailCampaignDeliverySettingsDto"},"EmailCampaignRecipientsSourceTypes":{"enum":["AllUsers","SpecifiedUsers","AccountUsers","Email","Collection"],"type":"string"},"RespectTimeZoneSettings":{"enum":["1 (RespectToLastLoginZone)","2 (RespectToRegistrationZone)","4 (RespectToRegistrationProjectZone)"],"type":"integer","format":"int32"},"CollectionEmailCampaignRecipientField":{"enum":["User","Email"],"type":"string"}}}}
```

### Push delivery — `PushCampaignDeliverySettingsDto`

| `recipientsSourceType` | Sends to                           | Concrete shape                               |
| ---------------------- | ---------------------------------- | -------------------------------------------- |
| `AllUsers`             | every user in the project          | `PushToAllUsersDeliverySettingsDto`          |
| `AccountUsers`         | users on the account               | `PushToAccountUsersDeliverySettingsDto`      |
| `SpecifiedUsers`       | a list of user ids                 | `PushToUsersDeliverySettingsDto`             |
| `Devices`              | specific device tokens             | `PushToDevicesDeliverySettingsDto`           |
| `Collection`           | records from a database collection | `PushToCollectionRecordsDeliverySettingsDto` |

## The PushCampaignDeliverySettingsDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"PushCampaignDeliverySettingsDto":{"title":"PushCampaignDeliverySettingsDto","type":"object","properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/PushCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"}},"description":"PushCampaignDeliverySettingsDto"},"PushCampaignRecipientsSourceTypes":{"enum":["AllUsers","SpecifiedUsers","Collection","Devices","AccountUsers"],"type":"string"},"RespectTimeZoneSettings":{"enum":["1 (RespectToLastLoginZone)","2 (RespectToRegistrationZone)","4 (RespectToRegistrationProjectZone)"],"type":"integer","format":"int32"}}}}
```

## The PushToAllUsersDeliverySettingsDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"PushToAllUsersDeliverySettingsDto":{"title":"PushToAllUsersDeliverySettingsDto","type":"object","allOf":[{"$ref":"#/components/schemas/PushCampaignDeliverySettingsDto"}],"properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/PushCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"},"rolesNames":{"$ref":"#/components/schemas/HashSet<String>"},"userTags":{"$ref":"#/components/schemas/HashSet<String>"}},"description":"PushToAllUsersDeliverySettingsDto"},"PushCampaignDeliverySettingsDto":{"title":"PushCampaignDeliverySettingsDto","type":"object","properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/PushCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"}},"description":"PushCampaignDeliverySettingsDto"},"PushCampaignRecipientsSourceTypes":{"enum":["AllUsers","SpecifiedUsers","Collection","Devices","AccountUsers"],"type":"string"},"RespectTimeZoneSettings":{"enum":["1 (RespectToLastLoginZone)","2 (RespectToRegistrationZone)","4 (RespectToRegistrationProjectZone)"],"type":"integer","format":"int32"}}}}
```

## The PushToAccountUsersDeliverySettingsDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"PushToAccountUsersDeliverySettingsDto":{"title":"PushToAccountUsersDeliverySettingsDto","type":"object","allOf":[{"$ref":"#/components/schemas/PushCampaignDeliverySettingsDto"}],"properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/PushCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"},"recipients":{"$ref":"#/components/schemas/HashSet<String>"}},"description":"PushToAccountUsersDeliverySettingsDto"},"PushCampaignDeliverySettingsDto":{"title":"PushCampaignDeliverySettingsDto","type":"object","properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/PushCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"}},"description":"PushCampaignDeliverySettingsDto"},"PushCampaignRecipientsSourceTypes":{"enum":["AllUsers","SpecifiedUsers","Collection","Devices","AccountUsers"],"type":"string"},"RespectTimeZoneSettings":{"enum":["1 (RespectToLastLoginZone)","2 (RespectToRegistrationZone)","4 (RespectToRegistrationProjectZone)"],"type":"integer","format":"int32"}}}}
```

## The PushToUsersDeliverySettingsDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"PushToUsersDeliverySettingsDto":{"title":"PushToUsersDeliverySettingsDto","type":"object","allOf":[{"$ref":"#/components/schemas/PushCampaignDeliverySettingsDto"}],"properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/PushCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"},"recipients":{"$ref":"#/components/schemas/HashSet<String>"}},"description":"PushToUsersDeliverySettingsDto"},"PushCampaignDeliverySettingsDto":{"title":"PushCampaignDeliverySettingsDto","type":"object","properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/PushCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"}},"description":"PushCampaignDeliverySettingsDto"},"PushCampaignRecipientsSourceTypes":{"enum":["AllUsers","SpecifiedUsers","Collection","Devices","AccountUsers"],"type":"string"},"RespectTimeZoneSettings":{"enum":["1 (RespectToLastLoginZone)","2 (RespectToRegistrationZone)","4 (RespectToRegistrationProjectZone)"],"type":"integer","format":"int32"}}}}
```

## The PushToDevicesDeliverySettingsDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"PushToDevicesDeliverySettingsDto":{"title":"PushToDevicesDeliverySettingsDto","type":"object","allOf":[{"$ref":"#/components/schemas/PushCampaignDeliverySettingsDto"}],"properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/PushCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"},"devices":{"$ref":"#/components/schemas/HashSet<PushDeviceDeliveryTokenDto>"}},"description":"PushToDevicesDeliverySettingsDto"},"PushCampaignDeliverySettingsDto":{"title":"PushCampaignDeliverySettingsDto","type":"object","properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/PushCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"}},"description":"PushCampaignDeliverySettingsDto"},"PushCampaignRecipientsSourceTypes":{"enum":["AllUsers","SpecifiedUsers","Collection","Devices","AccountUsers"],"type":"string"},"RespectTimeZoneSettings":{"enum":["1 (RespectToLastLoginZone)","2 (RespectToRegistrationZone)","4 (RespectToRegistrationProjectZone)"],"type":"integer","format":"int32"}}}}
```

## The PushToCollectionRecordsDeliverySettingsDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"PushToCollectionRecordsDeliverySettingsDto":{"title":"PushToCollectionRecordsDeliverySettingsDto","type":"object","allOf":[{"$ref":"#/components/schemas/PushCampaignDeliverySettingsDto"}],"properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/PushCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"},"fields":{"$ref":"#/components/schemas/HashSet<String>"},"fieldType":{"$ref":"#/components/schemas/CollectionEmailCampaignRecipientField"},"languages":{"$ref":"#/components/schemas/HashSet<String>"},"roleNames":{"$ref":"#/components/schemas/HashSet<String>"},"schemaName":{"type":"string"}},"description":"PushToCollectionRecordsDeliverySettingsDto"},"PushCampaignDeliverySettingsDto":{"title":"PushCampaignDeliverySettingsDto","type":"object","properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/PushCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"}},"description":"PushCampaignDeliverySettingsDto"},"PushCampaignRecipientsSourceTypes":{"enum":["AllUsers","SpecifiedUsers","Collection","Devices","AccountUsers"],"type":"string"},"RespectTimeZoneSettings":{"enum":["1 (RespectToLastLoginZone)","2 (RespectToRegistrationZone)","4 (RespectToRegistrationProjectZone)"],"type":"integer","format":"int32"},"CollectionEmailCampaignRecipientField":{"enum":["User","Email"],"type":"string"}}}}
```

### SMS delivery — `SmsCampaignDeliverySettingsDto`

| `recipientsSourceType` | Sends to                           | Concrete shape                              |
| ---------------------- | ---------------------------------- | ------------------------------------------- |
| `AllUsers`             | every user in the project          | `SmsToAllUsersDeliverySettingsDto`          |
| `SpecifiedUsers`       | a list of user ids                 | `SmsToUsersDeliverySettingsDto`             |
| `PhoneNumbers`         | raw phone numbers                  | `SmsToPhoneNumbersDeliverySettingsDto`      |
| `Collection`           | records from a database collection | `SmsToCollectionRecordsDeliverySettingsDto` |

## The SmsCampaignDeliverySettingsDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"SmsCampaignDeliverySettingsDto":{"title":"SmsCampaignDeliverySettingsDto","type":"object","properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/SmsCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"}},"description":"SmsCampaignDeliverySettingsDto"},"SmsCampaignRecipientsSourceTypes":{"enum":["AllUsers","SpecifiedUsers","AccountUsers","PhoneNumbers","Collection"],"type":"string"},"RespectTimeZoneSettings":{"enum":["1 (RespectToLastLoginZone)","2 (RespectToRegistrationZone)","4 (RespectToRegistrationProjectZone)"],"type":"integer","format":"int32"}}}}
```

## The SmsToAllUsersDeliverySettingsDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"SmsToAllUsersDeliverySettingsDto":{"title":"SmsToAllUsersDeliverySettingsDto","type":"object","allOf":[{"$ref":"#/components/schemas/SmsCampaignDeliverySettingsDto"}],"properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/SmsCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"},"rolesNames":{"$ref":"#/components/schemas/HashSet<String>"},"userTags":{"$ref":"#/components/schemas/HashSet<String>"}},"description":"SmsToAllUsersDeliverySettingsDto"},"SmsCampaignDeliverySettingsDto":{"title":"SmsCampaignDeliverySettingsDto","type":"object","properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/SmsCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"}},"description":"SmsCampaignDeliverySettingsDto"},"SmsCampaignRecipientsSourceTypes":{"enum":["AllUsers","SpecifiedUsers","AccountUsers","PhoneNumbers","Collection"],"type":"string"},"RespectTimeZoneSettings":{"enum":["1 (RespectToLastLoginZone)","2 (RespectToRegistrationZone)","4 (RespectToRegistrationProjectZone)"],"type":"integer","format":"int32"}}}}
```

## The SmsToUsersDeliverySettingsDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"SmsToUsersDeliverySettingsDto":{"title":"SmsToUsersDeliverySettingsDto","type":"object","allOf":[{"$ref":"#/components/schemas/SmsCampaignDeliverySettingsDto"}],"properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/SmsCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"},"recipients":{"$ref":"#/components/schemas/HashSet<String>"}},"description":"SmsToUsersDeliverySettingsDto"},"SmsCampaignDeliverySettingsDto":{"title":"SmsCampaignDeliverySettingsDto","type":"object","properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/SmsCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"}},"description":"SmsCampaignDeliverySettingsDto"},"SmsCampaignRecipientsSourceTypes":{"enum":["AllUsers","SpecifiedUsers","AccountUsers","PhoneNumbers","Collection"],"type":"string"},"RespectTimeZoneSettings":{"enum":["1 (RespectToLastLoginZone)","2 (RespectToRegistrationZone)","4 (RespectToRegistrationProjectZone)"],"type":"integer","format":"int32"}}}}
```

## The SmsToPhoneNumbersDeliverySettingsDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"SmsToPhoneNumbersDeliverySettingsDto":{"title":"SmsToPhoneNumbersDeliverySettingsDto","type":"object","allOf":[{"$ref":"#/components/schemas/SmsCampaignDeliverySettingsDto"}],"properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/SmsCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"},"phoneNumbers":{"$ref":"#/components/schemas/HashSet<String>"}},"description":"SmsToPhoneNumbersDeliverySettingsDto"},"SmsCampaignDeliverySettingsDto":{"title":"SmsCampaignDeliverySettingsDto","type":"object","properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/SmsCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"}},"description":"SmsCampaignDeliverySettingsDto"},"SmsCampaignRecipientsSourceTypes":{"enum":["AllUsers","SpecifiedUsers","AccountUsers","PhoneNumbers","Collection"],"type":"string"},"RespectTimeZoneSettings":{"enum":["1 (RespectToLastLoginZone)","2 (RespectToRegistrationZone)","4 (RespectToRegistrationProjectZone)"],"type":"integer","format":"int32"}}}}
```

## The SmsToCollectionRecordsDeliverySettingsDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"SmsToCollectionRecordsDeliverySettingsDto":{"title":"SmsToCollectionRecordsDeliverySettingsDto","type":"object","allOf":[{"$ref":"#/components/schemas/SmsCampaignDeliverySettingsDto"}],"properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/SmsCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"},"fields":{"$ref":"#/components/schemas/HashSet<String>"},"fieldType":{"$ref":"#/components/schemas/CollectionEmailCampaignRecipientField"},"languages":{"$ref":"#/components/schemas/HashSet<String>"},"roleNames":{"$ref":"#/components/schemas/HashSet<String>"},"schemaName":{"type":"string"}},"description":"SmsToCollectionRecordsDeliverySettingsDto"},"SmsCampaignDeliverySettingsDto":{"title":"SmsCampaignDeliverySettingsDto","type":"object","properties":{"campaignTime":{"type":"integer","format":"int64","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"recipientsSourceType":{"$ref":"#/components/schemas/SmsCampaignRecipientsSourceTypes"},"respectTimeZoneSettings":{"$ref":"#/components/schemas/RespectTimeZoneSettings"}},"description":"SmsCampaignDeliverySettingsDto"},"SmsCampaignRecipientsSourceTypes":{"enum":["AllUsers","SpecifiedUsers","AccountUsers","PhoneNumbers","Collection"],"type":"string"},"RespectTimeZoneSettings":{"enum":["1 (RespectToLastLoginZone)","2 (RespectToRegistrationZone)","4 (RespectToRegistrationProjectZone)"],"type":"integer","format":"int32"},"CollectionEmailCampaignRecipientField":{"enum":["User","Email"],"type":"string"}}}}
```

### Webhook, Code and SSE delivery

Webhook, Code and SSE (realtime) actions use a single, non-polymorphic delivery-settings shape each:

## The WebhookDeliverySettingsDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"WebhookDeliverySettingsDto":{"title":"WebhookDeliverySettingsDto","type":"object","properties":{"contentType":{"type":"string","nullable":true},"destinationIds":{"type":"array","items":{"type":"string"},"nullable":true},"eventName":{"type":"string","nullable":true},"includeRawPayload":{"type":"boolean"},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"}},"description":"WebhookDeliverySettingsDto"}}}}
```

## The CodeDeliverySettingsDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"CodeDeliverySettingsDto":{"title":"CodeDeliverySettingsDto","type":"object","properties":{"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"}},"description":"CodeDeliverySettingsDto"}}}}
```

## The SseDeliverySettingsDto object

```json
{"openapi":"3.0.4","info":{"title":"Norbix Hub API","version":"1.0"},"components":{"schemas":{"SseDeliverySettingsDto":{"title":"SseDeliverySettingsDto","type":"object","properties":{"audience":{"type":"string"},"eventName":{"type":"string","nullable":true},"mappedTokens":{"$ref":"#/components/schemas/HashSet<TokenMappingDto>"},"payloadTemplate":{"type":"string","nullable":true},"payloadType":{"type":"string","nullable":true},"persist":{"type":"boolean"},"userAuthIds":{"$ref":"#/components/schemas/HashSet<String>"}},"description":"SseDeliverySettingsDto"}}}}
```

## In the dashboard

Manage this visually in Norbix Cloud — see [Payments → Triggers](/norbix-cloud/payments/triggers.md).

## Use it from code

Call it from any Norbix SDK — see [Save Payments Trigger](/sdks-and-cli/payments/triggers/save-payments-trigger.md) in the SDK reference.