Skip to main content
POST
Create an automation trigger

Authorizations

Authorization
string
header
required

API key or personal access token (NEX-1042). Send as Authorization: Bearer <token>. Token format:

  • nex_live_… — live API key (server-to-server)
  • nex_test_… — sandbox API key
  • nex_pat_… — personal access token (acts as the issuing user)

Authorization is decided by the key's scopes array, not the owning user's RBAC role. See POST /api/api-keys to mint a key.

Path Parameters

id
integer
required

Body

application/json

Create/update payload for an automation trigger.

triggerType
enum<string>
required
Available options:
schedule,
event,
manual,
webhook
cronExpression
string

Required + validated for schedule triggers.

timezone
string
eventType
string

Required for event triggers.

eventFilters
object
runAsUserId
integer

Defaults to the caller; binding another user needs internal-operator rights.

facilityId
integer | null
seedMessage
string
isActive
boolean

Response

Trigger created

An automation trigger that fires an agent on a schedule or event.

id
integer
required
agentDefinitionId
integer
required
triggerType
enum<string>
required
Available options:
schedule,
event,
manual,
webhook
cronExpression
string | null

5-field cron; required for schedule triggers.

timezone
string | null

IANA timezone for cron evaluation (defaults to UTC).

eventType
string | null

Business event name; required for event triggers (e.g. shift.ncns).

eventFilters
object

Equality filters (dot-path) the event payload must satisfy.

runAsUserId
integer | null

Identity the run acts as (drives tool scope + RBAC).

facilityId
integer | null
seedMessage
string | null
isActive
boolean
lastRunAt
string<date-time> | null
nextRunAt
string<date-time> | null
consecutiveFailures
integer

Auto-disabled after 5 consecutive schedule-dispatch failures.