Email Changes Notifications API

The Email Change Notification API allows you to receive information about the time and author of each autosave for security and atomic integrity purposes during simultaneous editing. This webhook needs to be specified in the plugin settings to function correctly.

To ensure that the webhook functions correctly, you need to specify an endpoint in the plugin settings that meets the following specifications.

Server

https://{YOUR_EMAIL_CHANGE_NOTIFICATION_URL}

YOUR_EMAIL_CHANGE_NOTIFICATION_URL

Client Libraries

Shell Curl

Methods

Methods Operations

post/

Notification on email changes

Provides details about the time and author of each autosave, ensuring security and atomic integrity during simultaneous editing.

Body·

required

application/json

dateTime
Type: integerFormat: int64
required

Signed 64-bit integers (long type).
emailId
Type: string
required
userId
Type: string
required

Responses

200
Type: object | null

Successful response

application/json

post/

curl 'https://{YOUR_EMAIL_CHANGE_NOTIFICATION_URL}/' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Basic username:password' \
  --data '{
  "emailId": "",
  "userId": "",
  "dateTime": 1
}'

Show Schema

null

Successful response

Models

dateTime
Type: integerFormat: int64
required

Signed 64-bit integers (long type).
emailId
Type: string
required
userId
Type: string
required