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:
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 /notifications \
  --request POST \
  --header 'Content-Type: application/json' \
  --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

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