POST

Notify


Sends notifications based on the template and dynamic values provided.

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

When you create a notification template (SDK | REST), you are provided with a notification template ID. Call the Notify method 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

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

Permissions
Manage Notifications
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/notifications/v3/notify

Body Params
notificationTemplateIdstringRequiredformat GUID

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.


dynamicValuesMap <string, DynamicValue>format map

Each key is a placeholder name you specify when creating a notification template. The value is an object containing the text to replace the placeholder in the notifications.

Response Object
notificationBatchIdstring

ID of the batch of notifications triggered by one request.

Send notifications (with dynamic values)
Request
cURL
Response
JSON
Errors

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

Did this help?