Actions28
- Entity Actions
- Relation Actions
- Query Actions
- Search Actions
- Tool Actions
Tool → Send Notification
AI-generatedSummary
Send a notification to specified Efficy users or user groups via the Efficy API.
Inputs
- Users (required) — Semicolon-separated Efficy user or group codes to receive the notification.
- Subject (required) — Subject text of the notification.
- Body — Optional body text of the notification.
- Entity — Optional Efficy entity code the notification relates to.
- Key — Optional key of the entity record the notification relates to.
- Custom Params (JSON) — Optional JSON object string with custom parameters to include in the notification.
- Options — Option to return the full API response array instead of just the first context result.
Output shape
a single JSON object representing the notification response or the full API response array if specified
By default, returns the first context result from the API response. If 'Return Full Response' option is true, returns the complete API response array. Errors during execution will either stop the workflow or be returned as error objects if 'Continue On Fail' is enabled.
Examples
Example 1: Notify specific users/groups about an important update
Set 'Users' to the semicolon-separated list of target user codes, provide a concise 'Subject', optionally add 'Body' text, and leave 'Entity' and 'Key' blank if not relating to specific records.
Example 2: Send a notification relating to a specific entity record
Fill 'Entity' with the entity code and 'Key' with the record identifier to link the notification to that record.