BulkTriggerEvent
One notification workflow trigger included in a bulk submission.
Usage profiles
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
In requests
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
workflowId | string | Required in requests | Identifier of the notification workflow to execute or configure. Minimum length: 1. |
userId | string | Required in requests | Identifier of the user associated with the operation. Minimum length: 1. |
payload | Map from string to JSON value | Optional | Template variables and event data passed to the notification workflow. |
overrides | Map from string to JSON value | Optional | Provider-specific overrides applied to the notification trigger. |
transactionId | string | Optional | Identifier correlating a notification trigger with later status or cancellation requests. |
Request validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
workflowId | Minimum length | 1 |
userId | Minimum length | 1 |
Where used
| Reference | Relationship |
|---|---|
| Send a notification to multiple users | POST /api/v1/notifications/manage/send-bulk |
Download the public reference contract.
Document: DOC-API-MODEL-bulk-trigger-event.