Plugin Docs

Appearance

v1.0.0
OAS 3.0.3

Comments Notification API

Stripo Support

This API specification describes the webhook endpoint that plugin servers must implement to receive notification events from the Stripo Email Editor.

The editor will POST notification events to the configured plugin URL when specific actions occur (e.g., comments created, replied, resolved, or viewed).

Authentication: HTTP Basic Authentication is required. The editor will send credentials configured in the plugin settings.

Important: All event type and subtype values use UPPERCASE with underscores.

Server:https://{YOUR_PLUGIN_NOTIFICATION_URL}

Plugin notification webhook endpoint (configure in plugin settings)

Client Libraries
Shell Curl

Receive plugin notification events

​

Endpoint to receive notification events from the Stripo Email Editor.

Your plugin server must implement this endpoint and respond with either:

  • 200 OK (with optional response body)
  • 204 No Content (no response body)

Any other status code will be treated as an error.

Body
required
application/json
  • createdOn
    Type: integerFormat: int64
    required

    Unix timestamp in milliseconds when the event was created

  • details
    required

    Details for a comment creation event

    • commentAuthorId
      Type: string
      required

      User ID of the comment author (string format)

    • commentId
      Type: string
      required

      Unique identifier of the created comment

    • commentText
      Type: string
      required

      Text content of the comment

    • emailId
      Type: string
      required

      Unique identifier of the email template

    • taggedUserIds
      Type: array string[]

      List of user IDs tagged in the comment (optional, string array)

  • pluginId
    Type: string
    required

    Unique identifier of the plugin this event is for

  • subtype
    Type: stringenum
    required

    Specific event type within the category

    • COMMENT_CREATED
    • COMMENT_REPLIED
    • COMMENT_RESOLVED
    • COMMENT_VIEWED
  • type
    enum
    const:  
    EDITOR_COMMENTS
    required

    High-level event category (always "EDITOR_COMMENTS" for comment events)

    • EDITOR_COMMENTS
Responses
  • 200
    Type: object
    • message
      Type: string
  • 204

    Event received and processed successfully (no content)

  • 400
    Type: object

    Standard error response format

    • error
      Type: string

      Error type or category

    • message
      Type: string

      Detailed error message

  • 401
    Type: object

    Standard error response format

    • error
      Type: string

      Error type or category

    • message
      Type: string

      Detailed error message

  • 500
    Type: object

    Standard error response format

    • error
      Type: string

      Error type or category

    • message
      Type: string

      Detailed error message

Request Example for post/notifications
curl 'https://{YOUR_PLUGIN_NOTIFICATION_URL}/notifications' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Basic username:password' \
  --data '{
  "createdOn": 1699564800000,
  "type": "EDITOR_COMMENTS",
  "subtype": "COMMENT_CREATED",
  "pluginId": "my-plugin-123",
  "details": {
    "emailId": "email-456",
    "commentId": "comment-789",
    "commentAuthorId": "user-001",
    "commentText": "This looks great!",
    "taggedUserIds": [
      "user-002",
      "user-003"
    ]
  }
}'

{
  "message": "Event processed successfully"
}

Event received and processed successfully

Models

  • createdOn
    Type: integerFormat: int64
    required

    Unix timestamp in milliseconds when the event was created

  • details
    required

    Details for a comment creation event

    • commentAuthorId
      Type: string
      required

      User ID of the comment author (string format)

    • commentId
      Type: string
      required

      Unique identifier of the created comment

    • commentText
      Type: string
      required

      Text content of the comment

    • emailId
      Type: string
      required

      Unique identifier of the email template

    • taggedUserIds
      Type: array string[]

      List of user IDs tagged in the comment (optional, string array)

  • pluginId
    Type: string
    required

    Unique identifier of the plugin this event is for

  • subtype
    Type: stringenum
    required

    Specific event type within the category

    • COMMENT_CREATED
    • COMMENT_REPLIED
    • COMMENT_RESOLVED
    • COMMENT_VIEWED
  • type
    enum
    const:  
    EDITOR_COMMENTS
    required

    High-level event category (always "EDITOR_COMMENTS" for comment events)

    • EDITOR_COMMENTS

Details for a comment creation event

  • commentAuthorId
    Type: string
    required

    User ID of the comment author (string format)

  • commentId
    Type: string
    required

    Unique identifier of the created comment

  • commentText
    Type: string
    required

    Text content of the comment

  • emailId
    Type: string
    required

    Unique identifier of the email template

  • taggedUserIds
    Type: array string[]

    List of user IDs tagged in the comment (optional, string array)

Details for a comment reply event

  • commentId
    Type: string
    required

    Unique identifier of the reply comment

  • commentText
    Type: string
    required

    Text content of the reply

  • emailId
    Type: string
    required

    Unique identifier of the email template

  • initialCommentAuthorId
    Type: string
    required

    User ID of the author who created the initial comment (string format)

  • initialCommentCreationDate
    Type: integerFormat: int64
    required

    Unix timestamp in milliseconds when the initial comment was created

  • initialCommentText
    Type: string
    required

    Text content of the initial comment in the thread

  • repliesCount
    Type: integerFormat: int32
    required

    Total number of replies in the thread

  • replyAuthorId
    Type: string
    required

    User ID of the reply author (string format)

  • threadCommentId
    Type: string
    required

    Unique identifier of the parent comment thread

  • taggedUserIds
    Type: array string[]

    List of user IDs tagged in the reply (optional, string array)

  • threadUserIds
    Type: array string[]

    List of all user IDs participating in the thread (optional, string array)

Details for a comment resolution event

  • commentAuthorId
    Type: string
    required

    User ID of the original comment author (string format)

  • commentId
    Type: string
    required

    Unique identifier of the resolved comment

  • commentText
    Type: string
    required

    Text content of the resolved comment

  • emailId
    Type: string
    required

    Unique identifier of the email template

  • resolveUserId
    Type: string
    required

    User ID of the person who resolved the comment (string format)

  • threadCommentId
    Type: string
    required

    Unique identifier of the comment thread

  • threadUserIds
    Type: array string[]

    List of all user IDs participating in the thread (optional, string array)

Details for a comment view event

  • commentId
    Type: string
    required

    Unique identifier of the viewed comment

  • emailId
    Type: string
    required

    Unique identifier of the email template

  • threadCommentId
    Type: string
    required

    Unique identifier of the comment thread

  • viewerId
    Type: string
    required

    User ID of the person who viewed the comment (string format)

Standard error response format

  • error
    Type: string

    Error type or category

  • message
    Type: string

    Detailed error message

© 2026 Stripо.email — Next Generation Email Editor.