notify( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Sends notifications based on the template and dynamic values provided.

This feature is not yet available to all users.

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

When you create a notification template in the Wix Dev Center, you are given a notification template ID. Call the Notify endpoint with this ID as notificationTemplateID to trigger notifications based on the notification 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 seamlessly in the notifications sent out.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

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 the Wix Dev Center.


optionsNotifyOptions
Returns
Return Type:Promise<NotifyResponse>
Was this helpful?
Yes
No