Project Screen

This event is used to notify webhooks about changes related to a screen in Zeplin projects.

Actions

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

Context

AttributeTypeDescription
projectProjectProject that contains the screen
versionScreen Version Summary (optional)The details of the screen's version (exists for all actions except deleted action).

Resource

AttributeTypeDescription
idstringUnique id of the resource
typestring ("Screen")Type of the resource (one of the API models)
dataScreenObject representing the resource content

Example

{
  "event": "project.screen",
  "action": "created",
  "timestamp": 1572347818,
  "resource": {
    "id": "5dbad85a76ea51c1f35b6f69",
    "type": "Screen",
    "data": {
      "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"
        }
      }
    }
  },
  "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"
      }
    },
    "version": {
      "id": "5dbad85a76ea51c1f35b6f69",
      "creator": {
        "id": "5d9caaecb4a3fa9bc9718686",
        "email": "[email protected]",
        "username": "zozo",
        "emotar": "🍎",
        "avatar": "http://placekitten.com/200/300",
        "last_seen": 1616739240
      },
      "commit": {
        "message": "Update paddings",
        "author": {
          "id": "5d9caaecb4a3fa9bc9718686",
          "email": "[email protected]",
          "username": "zozo",
          "emotar": "🍎",
          "avatar": "http://placekitten.com/200/300",
          "last_seen": 1616739240
        },
        "color": {
          "r": 145,
          "g": 223,
          "b": 33,
          "a": 1
        }
      },
      "image_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"
      },
      "width": 2560,
      "height": 1920,
      "density_scale": 2,
      "source": "sketch/value",
      "background_color": {
        "source_id": "0BEBFEB3-A107-4D1D-A3B0-77D1FBD35F01",
        "r": 143,
        "g": 152,
        "b": 5,
        "a": 1
      },
      "links": [
        {
          "rect": {
            "x": 0,
            "y": 0,
            "width": 40,
            "height": 40
          },
          "destination": {
            "name": "Artboard",
            "type": "screen"
          }
        }
      ]
    }
  },
  "actor": {
    "user": {
      "id": "5d9caaecb4a3fa9bc9718686",
      "email": "[email protected]",
      "username": "zozo",
      "emotar": "🍎",
      "avatar": "http://placekitten.com/200/300",
      "last_seen": 1616739240
    }
  }
}