triggers

Create a trigger

post/sheets/{sheetId}/triggers

Request

  • Base URL: https://api.orcascan.com/v1
  • URL: https://api.orcascan.com/v1/sheets/{sheetId}/triggers
  • Auth: HTTP bearer

Request body

namestring required

Trigger name

conditionFieldstring required

Field title to evaluate. For exists in / does not exist in, use the barcode column

conditionType'is empty' | 'is not empty' | 'contains' | 'does not contain' | 'starts with' | 'does not start with' | 'ends with' | 'does not end with' | 'equals' | 'does not equal' | 'is less than' | 'is greater than' | 'matches regex' | 'does not match regex' | 'contains GS1 AI' | 'exists in' | 'does not exist in' required

Condition operator

conditionValuestring

Value to compare against. For exists in / does not exist in: lookup (Lookup URL), datasource (a data source) or sheet (this sheet)

actionType'show' | 'hide' | 'set value' | 'clear value' | 'set readonly' | 'clear readonly' | 'set required' | 'clear required' | 'notify me' | 'play sound' | 'move row' | 'copy row' required

Action to perform when condition is met

actionFieldstring

Target field for the action

actionValuestring

Value to set when action is 'set value'

notifyMethod'email' | 'in app notification' | 'in app dialog'

Notification delivery method

notifyEmailsstring

Comma-separated email addresses for notifications (required when notifyMethod is email)

notifyType'success' | 'warning' | 'error'

Notification severity

soundType'success' | 'warning' | 'error'

Sound to play

toSheetstring

Target sheet for move/copy row actions

enabledboolean

Whether the trigger is active

Response

Created trigger wrapped in data envelope

Changes

No recorded changes to this operation across all 1 revision of this API.