Project Note Comment

This event is used to notify webhooks about changes related to the comments in notes in Zeplin projects.

Actions

  • "created"
  • "deleted"
  • "updated"

Context

AttributeTypeDescription
projectProjectProject in which the comment has been added
screenScreenScreen in which the comment has been added
noteScreen NoteNote in which the comment has been added

Resource

AttributeTypeDescription
idstringUnique id of the resource
typestring ("ScreenNoteComment")Type of the resource (one of the API models)
dataScreen Note CommentObject representing the resource content

Example

{
  "event": "project.note.comment",
  "action": "created",
  "timestamp": 1572347818,
  "resource": {
    "id": "5dbad85a76ea51c1f35b6f69",
    "type": "ScreenNoteComment",
    "data": {
      "id": "5dbad85a76ea51c1f35b6f69",
      "created": 1572347818,
      "order": 1,
      "status": "open",
      "position": {
        "x": 0.93,
        "y": 0.1
      },
      "color": {
        "name": "yellow",
        "r": 254,
        "g": 207,
        "b": 51,
        "a": 1
      },
      "creator": {
        "id": "5d9caaecb4a3fa9bc9718686",
        "email": "[email protected]",
        "username": "zozo",
        "emotar": "🍎",
        "avatar": "http://placekitten.com/200/300",
        "last_seen": 1616739240
      },
      "comments": [
        {
          "id": "5dbad85a89ea51c1f35bcffe",
          "author": {
            "id": "5d9caaecb4a3fa9bc9718686",
            "email": "[email protected]",
            "username": "zozo",
            "emotar": "🍎",
            "avatar": "http://placekitten.com/200/300",
            "last_seen": 1616739240
          },
          "content": "Hey ho! Let's go!",
          "updated": 1572347818
        }
      ]
    }
  },
  "context": {
    "project": {
      "id": "5db81e73e1e36ee19f138c1a",
      "name": "HAL 9000",
      "description": "UI designs for the onboard computer on the spaceship Discovery 1",
      "platform": "web",
      "thumbnail": "http://placekitten.com/200/300",
      "status": "active",
      "scene_url": "https://scene.zeplin.io/project/5db81e73e1e36ee19f138c1a",
      "created": 1517184000,
      "updated": 1572347818,
      "number_of_members": 47,
      "number_of_screens": 112,
      "number_of_components": 46,
      "number_of_text_styles": 28,
      "number_of_colors": 17,
      "linked_styleguide": {
        "id": "5db81e6e6a4462065f04d932"
      }
    },
    "screen": {
      "id": "5dbad85a76ea51c1f35b6f69",
      "name": "Login",
      "description": "Login screen for HAL 9000",
      "tags": [
        "mobile",
        "login"
      ],
      "image": {
        "width": 2560,
        "height": 1920,
        "original_url": "http://placekitten.com/2560/1920",
        "thumbnails": {
          "small": "http://placekitten.com/256/256",
          "medium": "http://placekitten.com/512/512",
          "large": "http://placekitten.com/1024/1024"
        }
      },
      "created": 1517184000,
      "updated": 1572347818,
      "number_of_notes": 7,
      "number_of_versions": 4,
      "section": {
        "id": "5db81e6e6a4462065f04d932"
      },
      "variant": {
        "value": "Default",
        "group": {
          "id": "607437cd62d37a0bc869fc63",
          "name": "Login"
        }
      }
    },
    "note": {
      "id": "5dbad85a76ea51c1f35b6f69",
      "created": 1572347818,
      "order": 1,
      "status": "open",
      "position": {
        "x": 0.93,
        "y": 0.1
      },
      "color": {
        "name": "yellow",
        "r": 254,
        "g": 207,
        "b": 51,
        "a": 1
      },
      "creator": {
        "id": "5d9caaecb4a3fa9bc9718686",
        "email": "[email protected]",
        "username": "zozo",
        "emotar": "🍎",
        "avatar": "http://placekitten.com/200/300",
        "last_seen": 1616739240
      },
      "comments": [
        {
          "id": "5dbad85a89ea51c1f35bcffe",
          "author": {
            "id": "5d9caaecb4a3fa9bc9718686",
            "email": "[email protected]er.zeplin.io",
            "username": "zozo",
            "emotar": "🍎",
            "avatar": "http://placekitten.com/200/300",
            "last_seen": 1616739240
          },
          "content": "Hey ho! Let's go!",
          "updated": 1572347818
        }
      ]
    }
  },
  "actor": {
    "user": {
      "id": "5d9caaecb4a3fa9bc9718686",
      "email": "[email protected]",
      "username": "zozo",
      "emotar": "🍎",
      "avatar": "http://placekitten.com/200/300",
      "last_seen": 1616739240
    }
  }
}