Section ID:
Section ID:
DOC-API-MODEL-schema-oiqb7f8bbv#overview
BulkTriggerEvent
One notification workflow trigger included in a bulk submission.
Meaning and usage
Section ID: DOC-API-MODEL-schema-oiqb7f8bbv#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-oiqb7f8bbv#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
In requests
Section ID: DOC-API-MODEL-schema-oiqb7f8bbv#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-oiqb7f8bbv#field-workflowidSection ID: DOC-API-MODEL-schema-oiqb7f8bbv#request-field-workflowidworkflowId | string | Required in requests | Identifier of the notification workflow to trigger. Minimum length: 1. |
Section ID: DOC-API-MODEL-schema-oiqb7f8bbv#field-useridSection ID: DOC-API-MODEL-schema-oiqb7f8bbv#request-field-useriduserId | string | Required in requests | Identifier of the user associated with the operation. Minimum length: 1. |
Section ID: DOC-API-MODEL-schema-oiqb7f8bbv#field-payloadSection ID: DOC-API-MODEL-schema-oiqb7f8bbv#request-field-payloadpayload | Map from string to JSON value | Optional | Template variables and event data passed to the notification workflow. |
Section ID: DOC-API-MODEL-schema-oiqb7f8bbv#field-overridesSection ID: DOC-API-MODEL-schema-oiqb7f8bbv#request-field-overridesoverrides | Map from string to JSON value | Optional | Provider-specific overrides applied to the notification trigger. |
Section ID: DOC-API-MODEL-schema-oiqb7f8bbv#field-transactionidSection ID: DOC-API-MODEL-schema-oiqb7f8bbv#request-field-transactionidtransactionId | string | Optional | Identifier correlating a notification trigger with later status or cancellation requests. |
DOC-API-MODEL-schema-oiqb7f8bbv#validation
Request validation
Section ID: DOC-API-MODEL-schema-oiqb7f8bbv#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
Section ID: DOC-API-MODEL-schema-oiqb7f8bbv#where-used
| Reference | Relationship |
|---|---|
| Send a notification to multiple users | POST /api/v1/notifications/manage/send-bulk |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-oiqb7f8bbv