Save Schema Trigger

Create or update a schema (database) trigger.

A schema trigger runs an action automatically when records change in a collection — for example emailing the team when a record is inserted, or calling a webhook when one is deleted. It watches one schema (set schemaId) and fires on OnInserted, OnUpdated, or OnDeleted.

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

post

Authorizations

HTTPRequired

JWT Bearer Authorization

Body

SaveSchemaTrigger

correlationIdstring · nullableOptional

CorrelationId for each request

cultureCodestring · nullableOptional

Specify culture code when your response from the API should be localised. E.g.: en

timeZoneIdstring · nullableOptional

TimeZone

versionstring · nullableRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

envstring · nullableOptional

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.

projectIdstringRequired

ID of your project. Can be passed in a header as norbix-project-id.

Responses

200

OK

application/json

idstring · nullableOptional

statusstring · nullableOptional

post/api/SaveSchemaTrigger

POST /api/SaveSchemaTrigger HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 289

{
  "correlationId": "text",
  "cultureCode": "text",
  "timeZoneId": "text",
  "version": "text",
  "env": "text",
  "projectId": "text",
  "trigger": {
    "type": "Membership",
    "triggerId": "text",
    "name": "text",
    "description": "text",
    "isEnabled": true,
    "preExecuteCode": "text",
    "action": {
      "integrationId": "text",
      "type": "Code"
    }
  }
}

200

OK

{
  "responseStatus": {
    "isSuccess": true,
    "errors": [
      {
        "message": "text",
        "errorCode": "text",
        "context": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "stackTrace": [
          {
            "message": "text",
            "errorCode": "text",
            "context": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "stackTrace": "[Circular Reference]"
          }
        ]
      }
    ],
    "success": {
      "isSuccess": true,
      "errors": [
        {
          "message": "text",
          "errorCode": "text",
          "context": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "stackTrace": [
            {
              "message": "text",
              "errorCode": "text",
              "context": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "stackTrace": "[Circular Reference]"
            }
          ]
        }
      ],
      "success": {
        "isSuccess": true,
        "errors": [
          {
            "message": "text",
            "errorCode": "text",
            "context": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "stackTrace": [
              {
                "message": "text",
                "errorCode": "text",
                "context": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "stackTrace": "[Circular Reference]"
              }
            ]
          }
        ],
        "success": {
          "isSuccess": true,
          "errors": [
            {
              "message": "text",
              "errorCode": "text",
              "context": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "stackTrace": [
                {
                  "message": "text",
                  "errorCode": "text",
                  "context": {
                    "ANY_ADDITIONAL_PROPERTY": "text"
                  },
                  "stackTrace": "[Circular Reference]"
                }
              ]
            }
          ],
          "success": {
            "isSuccess": true,
            "errors": "[Circular Reference]",
            "success": "[Circular Reference]"
          }
        }
      }
    }
  },
  "id": "text",
  "status": "text"
}

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 schema trigger, type is Schema and the body is a SchemaTriggerRequest — you do not send the abstract base directly:

when selects which event fires the trigger (see the SchemaTriggerType 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:

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

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

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

Webhook, Code and SSE delivery

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

In the dashboard

Manage this visually in Norbix Cloud — see Database → Collections → Triggers.

Use it from code

Call it from any Norbix SDK — see Save Schema Trigger in the SDK reference.