notify( )

Sends notifications based on the template and dynamic values provided.

Note: An app can call this endpoint up to 100,000 times per month for each site.

When you create a notification template, you are provided a notification template ID. Call the Notify endpoint with this ID as notificationTemplateID to trigger notifications based on that template.

If the notification template contains placeholders for dynamic values, provide those values as key-value pairs in the dynamicValues array. The values you specify are incorporated in the notifications sent out.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Notifications
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
notificationTemplateIdstringRequired

Notification template ID. A notification template specifies the text and recipients for notifications. To obtain a notification template ID, create a notification template in your app's dashboard.

optionsNotifyOptions
Returns
Return Type:Promise<NotifyResponse>
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?