/zeplin-admin | Type: Application | PCID required: Yes
Tools
zeplin_admin_create_organization_webhooks
Create organization webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | string | Yes | — | Organization id |
events | string[] | Yes | — | The events of the webhook |
name | string | No | — | The name of the webhook |
project_ids | string[] | Yes | — | The project ids of the webhook |
secret | string | Yes | — | The secret to be used to generate signatures for webhook requests |
status | string | No | — | The status of the webhook |
styleguide_ids | string[] | Yes | — | The styleguide ids of the webhook |
url | string | Yes | — | The URL of the webhook |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "Organization id"
},
"events": {
"type": "array",
"items": {
"type": "string",
"enum": [
"*",
"project.*",
"project.color",
"project.component",
"project.member",
"project.note",
"project.note.comment",
"project.note.comment.reaction",
"project.screen",
"project.screen.version",
"project.spacing_token",
"project.text_style",
"styleguide.*",
"styleguide.color",
"styleguide.component",
"styleguide.member",
"styleguide.spacing_token",
"styleguide.text_style",
"workspace.*",
"workspace.project",
"workspace.styleguide",
"workspace.organization",
"workspace.organization.member"
]
},
"description": "The events of the webhook"
},
"name": {
"type": "string",
"description": "The name of the webhook"
},
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The project ids of the webhook"
},
"secret": {
"type": "string",
"description": "The secret to be used to generate signatures for webhook requests"
},
"status": {
"type": "string",
"description": "The status of the webhook",
"enum": [
"active",
"inactive"
]
},
"styleguide_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The styleguide ids of the webhook"
},
"url": {
"type": "string",
"description": "The URL of the webhook"
}
},
"required": [
"PCID",
"organization_id",
"events",
"project_ids",
"secret",
"styleguide_ids",
"url"
]
}
zeplin_admin_create_project_webhooks
Create project webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
events | string[] | Yes | — | The events of the webhook |
name | string | No | — | The name of the webhook |
secret | string | Yes | — | The secret to be used to generate signatures for webhook requests |
status | string | No | — | The status of the webhook |
url | string | Yes | — | The URL of the webhook |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project id"
},
"events": {
"type": "array",
"items": {
"type": "string",
"enum": [
"project.*",
"project.color",
"project.component",
"project.member",
"project.note",
"project.note.comment",
"project.note.comment.reaction",
"project.screen",
"project.screen.version",
"project.spacing_token",
"project.text_style",
"project.flow_board"
]
},
"description": "The events of the webhook"
},
"name": {
"type": "string",
"description": "The name of the webhook"
},
"secret": {
"type": "string",
"description": "The secret to be used to generate signatures for webhook requests"
},
"status": {
"type": "string",
"description": "The status of the webhook",
"enum": [
"active",
"inactive"
]
},
"url": {
"type": "string",
"description": "The URL of the webhook"
}
},
"required": [
"PCID",
"project_id",
"events",
"secret",
"url"
]
}
zeplin_admin_create_styleguide_webhooks
Create styleguide webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
styleguide_id | string | Yes | — | Styleguide id |
events | string[] | Yes | — | The events of the webhook |
name | string | No | — | The name of the webhook |
secret | string | Yes | — | The secret to be used to generate signatures for webhook requests |
status | string | No | — | The status of the webhook |
url | string | Yes | — | The URL of the webhook |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"styleguide_id": {
"type": "string",
"description": "Styleguide id"
},
"events": {
"type": "array",
"items": {
"type": "string",
"enum": [
"styleguide.*",
"styleguide.color",
"styleguide.component",
"styleguide.member",
"styleguide.spacing_token",
"styleguide.text_style"
]
},
"description": "The events of the webhook"
},
"name": {
"type": "string",
"description": "The name of the webhook"
},
"secret": {
"type": "string",
"description": "The secret to be used to generate signatures for webhook requests"
},
"status": {
"type": "string",
"description": "The status of the webhook",
"enum": [
"active",
"inactive"
]
},
"url": {
"type": "string",
"description": "The URL of the webhook"
}
},
"required": [
"PCID",
"styleguide_id",
"events",
"secret",
"url"
]
}
zeplin_admin_create_user_webhooks
Create user webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
events | string[] | Yes | — | The events of the webhook |
name | string | No | — | The name of the webhook |
project_ids | string[] | Yes | — | The project ids of the webhook |
secret | string | Yes | — | The secret to be used to generate signatures for webhook requests |
status | string | No | — | The status of the webhook |
styleguide_ids | string[] | Yes | — | The styleguide ids of the webhook |
url | string | Yes | — | The URL of the webhook |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"events": {
"type": "array",
"items": {
"type": "string",
"enum": [
"*",
"project.*",
"project.color",
"project.component",
"project.member",
"project.note",
"project.note.comment",
"project.note.comment.reaction",
"project.screen",
"project.screen.version",
"project.spacing_token",
"project.text_style",
"styleguide.*",
"styleguide.color",
"styleguide.component",
"styleguide.member",
"styleguide.spacing_token",
"styleguide.text_style",
"workspace.*",
"workspace.notification",
"workspace.project",
"workspace.styleguide"
]
},
"description": "The events of the webhook"
},
"name": {
"type": "string",
"description": "The name of the webhook"
},
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The project ids of the webhook"
},
"secret": {
"type": "string",
"description": "The secret to be used to generate signatures for webhook requests"
},
"status": {
"type": "string",
"description": "The status of the webhook",
"enum": [
"active",
"inactive"
]
},
"styleguide_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The styleguide ids of the webhook"
},
"url": {
"type": "string",
"description": "The URL of the webhook"
}
},
"required": [
"PCID",
"events",
"project_ids",
"secret",
"styleguide_ids",
"url"
]
}
zeplin_admin_delete_organization_webhook
Delete a webhook of an organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | string | Yes | — | Organization id |
webhook_id | string | Yes | — | Webhook id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "Organization id"
},
"webhook_id": {
"type": "string",
"description": "Webhook id"
}
},
"required": [
"PCID",
"organization_id",
"webhook_id"
]
}
zeplin_admin_delete_project_webhook
Delete a webhook of a project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
webhook_id | string | Yes | — | Webhook id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project id"
},
"webhook_id": {
"type": "string",
"description": "Webhook id"
}
},
"required": [
"PCID",
"project_id",
"webhook_id"
]
}
zeplin_admin_delete_styleguide_webhook
Delete a webhook of a styleguide Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
styleguide_id | string | Yes | — | Styleguide id |
webhook_id | string | Yes | — | Webhook id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"styleguide_id": {
"type": "string",
"description": "Styleguide id"
},
"webhook_id": {
"type": "string",
"description": "Webhook id"
}
},
"required": [
"PCID",
"styleguide_id",
"webhook_id"
]
}
zeplin_admin_delete_user_webhook
Delete a webhook of a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhook_id | string | Yes | — | Webhook id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"webhook_id": {
"type": "string",
"description": "Webhook id"
}
},
"required": [
"PCID",
"webhook_id"
]
}
zeplin_admin_get_current_user
Current userShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
zeplin_admin_get_organization
Get a single organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | string | Yes | — | Organization id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "Organization id"
}
},
"required": [
"PCID",
"organization_id"
]
}
zeplin_admin_get_organization_aliens
Get organization aliens Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | string | Yes | — | Organization id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "Organization id"
}
},
"required": [
"PCID",
"organization_id"
]
}
zeplin_admin_get_organization_billing
Get organization billing details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | string | Yes | — | Organization id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "Organization id"
}
},
"required": [
"PCID",
"organization_id"
]
}
zeplin_admin_get_organization_member_projects
Get a member’s projects Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | string | Yes | — | Organization id |
member_id | string | Yes | — | Member id |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "Organization id"
},
"member_id": {
"type": "string",
"description": "Member id"
},
"limit": {
"type": "integer",
"description": "Pagination limit"
},
"offset": {
"type": "integer",
"description": "Pagination offset"
}
},
"required": [
"PCID",
"organization_id",
"member_id"
]
}
zeplin_admin_get_organization_member_styleguides
Get a member’s styleguides Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | string | Yes | — | Organization id |
member_id | string | Yes | — | Member id |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "Organization id"
},
"member_id": {
"type": "string",
"description": "Member id"
},
"limit": {
"type": "integer",
"description": "Pagination limit"
},
"offset": {
"type": "integer",
"description": "Pagination offset"
}
},
"required": [
"PCID",
"organization_id",
"member_id"
]
}
zeplin_admin_get_organization_members
Get organization members Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | string | Yes | — | Organization id |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
handle | string[] | No | — | Filter organization members by email, username or unique identifier of the user ☝️Note that only organization admins (or higher) can filter members using email addresses. Example: ?handle=zozo&handle=5d9caaecb4a3fa9bc9718686&handle=zozo%40zeplin.io |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "Organization id"
},
"limit": {
"type": "integer",
"description": "Pagination limit"
},
"offset": {
"type": "integer",
"description": "Pagination offset"
},
"handle": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter organization members by email, username or unique identifier of the user ☝️Note that only organization admins (or higher) can filter members using email addresses. Example: `?handle=zozo&handle=5d9caaecb4a3fa9bc9718686&handle=zozo%40zeplin.io`"
}
},
"required": [
"PCID",
"organization_id"
]
}
zeplin_admin_get_organization_projects
Get organization projects Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | string | Yes | — | Organization id |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "Organization id"
},
"limit": {
"type": "integer",
"description": "Pagination limit"
},
"offset": {
"type": "integer",
"description": "Pagination offset"
}
},
"required": [
"PCID",
"organization_id"
]
}
zeplin_admin_get_organization_styleguides
Get organization styleguides Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | string | Yes | — | Organization id |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "Organization id"
},
"limit": {
"type": "integer",
"description": "Pagination limit"
},
"offset": {
"type": "integer",
"description": "Pagination offset"
}
},
"required": [
"PCID",
"organization_id"
]
}
zeplin_admin_get_organization_webhook
Get a webhook of organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | string | Yes | — | Organization id |
webhook_id | string | Yes | — | Webhook id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "Organization id"
},
"webhook_id": {
"type": "string",
"description": "Webhook id"
}
},
"required": [
"PCID",
"organization_id",
"webhook_id"
]
}
zeplin_admin_get_organization_webhooks
Get organization webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | string | Yes | — | Organization id |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
status | string | No | — | Filter by webhook status |
url_health | string | No | — | Filter by health of webhook’s URL |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "Organization id"
},
"limit": {
"type": "integer",
"description": "Pagination limit"
},
"offset": {
"type": "integer",
"description": "Pagination offset"
},
"status": {
"type": "string",
"description": "Filter by webhook status",
"enum": [
"active",
"inactive"
]
},
"url_health": {
"type": "string",
"description": "Filter by health of webhook's URL",
"enum": [
"healthy",
"unhealthy"
]
}
},
"required": [
"PCID",
"organization_id"
]
}
zeplin_admin_get_organization_workflow_statuses
Get organization workflow statuses Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | string | Yes | — | Organization id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "Organization id"
}
},
"required": [
"PCID",
"organization_id"
]
}
zeplin_admin_get_organizations
Get organizations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
role | string[] | No | — | Filter by role ☝️Note that the Developer role maps to member and the Reviewer role maps to alien in the API. Example: ?role=owner&role=admin |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"role": {
"type": "array",
"items": {
"type": "string",
"enum": [
"owner",
"admin",
"editor",
"member",
"alien"
]
},
"description": "Filter by role ☝️Note that the Developer role maps to `member` and the Reviewer role maps to `alien` in the API. Example: `?role=owner&role=admin`"
}
},
"required": [
"PCID"
]
}
zeplin_admin_get_project
Get a single project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project id"
}
},
"required": [
"PCID",
"project_id"
]
}
zeplin_admin_get_project_members
Get project members Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project id"
},
"limit": {
"type": "integer",
"description": "Pagination limit"
},
"offset": {
"type": "integer",
"description": "Pagination offset"
}
},
"required": [
"PCID",
"project_id"
]
}
zeplin_admin_get_project_webhook
Get a webhook of project Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
webhook_id | string | Yes | — | Webhook id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project id"
},
"webhook_id": {
"type": "string",
"description": "Webhook id"
}
},
"required": [
"PCID",
"project_id",
"webhook_id"
]
}
zeplin_admin_get_project_webhooks
Get project webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
status | string | No | — | Filter by webhook status |
url_health | string | No | — | Filter by health of webhook’s URL |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project id"
},
"limit": {
"type": "integer",
"description": "Pagination limit"
},
"offset": {
"type": "integer",
"description": "Pagination offset"
},
"status": {
"type": "string",
"description": "Filter by webhook status",
"enum": [
"active",
"inactive"
]
},
"url_health": {
"type": "string",
"description": "Filter by health of webhook's URL",
"enum": [
"healthy",
"unhealthy"
]
}
},
"required": [
"PCID",
"project_id"
]
}
zeplin_admin_get_projects
Get all projects Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Pagination limit |
workspace | string | No | — | Workspace of the project, it can be personal or the id of organization |
status | string | No | — | Filter by status |
offset | integer | No | — | Pagination offset |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Pagination limit"
},
"workspace": {
"type": "string",
"description": "Workspace of the project, it can be `personal` or the id of organization"
},
"status": {
"type": "string",
"description": "Filter by status",
"enum": [
"active",
"archived"
]
},
"offset": {
"type": "integer",
"description": "Pagination offset"
}
},
"required": [
"PCID"
]
}
zeplin_admin_get_styleguide_webhook
Get a webhook of styleguide Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
styleguide_id | string | Yes | — | Styleguide id |
webhook_id | string | Yes | — | Webhook id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"styleguide_id": {
"type": "string",
"description": "Styleguide id"
},
"webhook_id": {
"type": "string",
"description": "Webhook id"
}
},
"required": [
"PCID",
"styleguide_id",
"webhook_id"
]
}
zeplin_admin_get_styleguide_webhooks
Get styleguide webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
styleguide_id | string | Yes | — | Styleguide id |
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
status | string | No | — | Filter by webhook status |
url_health | string | No | — | Filter by health of webhook’s URL |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"styleguide_id": {
"type": "string",
"description": "Styleguide id"
},
"limit": {
"type": "integer",
"description": "Pagination limit"
},
"offset": {
"type": "integer",
"description": "Pagination offset"
},
"status": {
"type": "string",
"description": "Filter by webhook status",
"enum": [
"active",
"inactive"
]
},
"url_health": {
"type": "string",
"description": "Filter by health of webhook's URL",
"enum": [
"healthy",
"unhealthy"
]
}
},
"required": [
"PCID",
"styleguide_id"
]
}
zeplin_admin_get_user_notification
Get a notification of user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
notification_id | string | Yes | — | Notification id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"notification_id": {
"type": "string",
"description": "Notification id"
}
},
"required": [
"PCID",
"notification_id"
]
}
zeplin_admin_get_user_notifications
Get user notifications Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
is_read | boolean | No | — | Whether the notification is read or not |
type | string[] | No | — | Filter by type Example: ?type=project.extension&type=styleguide.extension |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Pagination limit"
},
"offset": {
"type": "integer",
"description": "Pagination offset"
},
"is_read": {
"type": "boolean",
"description": "Whether the notification is read or not"
},
"type": {
"type": "array",
"items": {
"type": "string",
"enum": [
"workspace.project",
"workspace.styleguide",
"project.extension",
"styleguide.extension",
"user.project_membership",
"user.styleguide_membership",
"project.component",
"styleguide.component",
"project.color",
"styleguide.color",
"project.screen.note",
"project.screen.note.comment",
"project.screen",
"project.text_style",
"styleguide.text_style",
"project.spacing_token",
"styleguide.spacing_token",
"project.jira_attachment",
"project.screen_section.jira_attachment",
"project.screen.jira_attachment",
"workspace.organization.member",
"project.slack_integration",
"styleguide.slack_integration",
"project.member",
"styleguide.member",
"project.flow_board"
]
},
"description": "Filter by type Example: `?type=project.extension&type=styleguide.extension`"
}
},
"required": [
"PCID"
]
}
zeplin_admin_get_user_projects
Get personal projects Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
status | string | No | — | Filter by status |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Pagination limit"
},
"offset": {
"type": "integer",
"description": "Pagination offset"
},
"status": {
"type": "string",
"description": "Filter by status",
"enum": [
"active",
"archived"
]
}
},
"required": [
"PCID"
]
}
zeplin_admin_get_user_styleguides
Get personal styleguides Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
status | string | No | — | Filter by status |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Pagination limit"
},
"offset": {
"type": "integer",
"description": "Pagination offset"
},
"status": {
"type": "string",
"description": "Filter by status",
"enum": [
"active",
"archived"
]
}
},
"required": [
"PCID"
]
}
zeplin_admin_get_user_webhook
Get a webhook of user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhook_id | string | Yes | — | Webhook id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"webhook_id": {
"type": "string",
"description": "Webhook id"
}
},
"required": [
"PCID",
"webhook_id"
]
}
zeplin_admin_get_user_webhooks
Get user webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Pagination limit |
offset | integer | No | — | Pagination offset |
status | string | No | — | Filter by webhook status |
url_health | string | No | — | Filter by health of webhook’s URL |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Pagination limit"
},
"offset": {
"type": "integer",
"description": "Pagination offset"
},
"status": {
"type": "string",
"description": "Filter by webhook status",
"enum": [
"active",
"inactive"
]
},
"url_health": {
"type": "string",
"description": "Filter by health of webhook's URL",
"enum": [
"healthy",
"unhealthy"
]
}
},
"required": [
"PCID"
]
}
zeplin_admin_invite_organization_member
Invite member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | string | Yes | — | Organization id |
handle | string | Yes | — | Email, username or unique identifier of the user |
restricted | boolean | Yes | — | Whether the user’s membership is restricted to only the projects that they are member of |
role | string | Yes | — | The role of the user in the organization ☝️Note that the Developer role maps to member and the Reviewer role maps to alien in the API. |
tags | string[] | No | — | Tags of the user in the organization |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "Organization id"
},
"handle": {
"type": "string",
"description": "Email, username or unique identifier of the user"
},
"restricted": {
"type": "boolean",
"description": "Whether the user's membership is restricted to only the projects that they are member of"
},
"role": {
"type": "string",
"description": "The role of the user in the organization ☝️Note that the Developer role maps to `member` and the Reviewer role maps to `alien` in the API.",
"enum": [
"admin",
"editor",
"member",
"alien"
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags of the user in the organization"
}
},
"required": [
"PCID",
"organization_id",
"handle",
"restricted",
"role"
]
}
zeplin_admin_invite_project_member
Invite a member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
handle | string | Yes | — | Email, username or unique identifier of the user Can also be "me" for joining the project as the current user |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project id"
},
"handle": {
"type": "string",
"description": "Email, username or unique identifier of the user Can also be `\"me\"` for joining the project as the current user"
}
},
"required": [
"PCID",
"project_id",
"handle"
]
}
zeplin_admin_remove_organization_member
Remove an organization member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | string | Yes | — | Organization id |
member_id | string | Yes | — | Member id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "Organization id"
},
"member_id": {
"type": "string",
"description": "Member id"
}
},
"required": [
"PCID",
"organization_id",
"member_id"
]
}
zeplin_admin_remove_project_member
Remove a member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
member_id | string | Yes | — | Member id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project id"
},
"member_id": {
"type": "string",
"description": "Member id"
}
},
"required": [
"PCID",
"project_id",
"member_id"
]
}
zeplin_admin_update_organization_member
Update an organization member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | string | Yes | — | Organization id |
member_id | string | Yes | — | Member id |
restricted | boolean | No | — | Whether the user’s membership is restricted to only the |
role | string | No | — | The role of the user in the organization ☝️Note that the Developer role maps to member and the Reviewer role maps to alien in the API. |
tags | string[] | No | — | Tags of the user in the organization |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "Organization id"
},
"member_id": {
"type": "string",
"description": "Member id"
},
"restricted": {
"type": "boolean",
"description": "Whether the user's membership is restricted to only the"
},
"role": {
"type": "string",
"description": "The role of the user in the organization ☝️Note that the Developer role maps to `member` and the Reviewer role maps to `alien` in the API.",
"enum": [
"admin",
"editor",
"member",
"alien"
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags of the user in the organization"
}
},
"required": [
"PCID",
"organization_id",
"member_id"
]
}
zeplin_admin_update_organization_webhooks
Update organization webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | string | Yes | — | Organization id |
webhook_id | string | Yes | — | Webhook id |
events | string[] | No | — | The events of the webhook |
name | string | No | — | The name of the webhook |
project_ids | string[] | No | — | The project ids of the webhook |
secret | string | No | — | The secret to be used to generate signatures for webhook requests |
status | string | No | — | The status of the webhook |
styleguide_ids | string[] | No | — | The styleguide ids of the webhook |
url | string | No | — | The URL of the webhook |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organization_id": {
"type": "string",
"description": "Organization id"
},
"webhook_id": {
"type": "string",
"description": "Webhook id"
},
"events": {
"type": "array",
"items": {
"type": "string",
"enum": [
"*",
"project.*",
"project.color",
"project.component",
"project.member",
"project.note",
"project.note.comment",
"project.note.comment.reaction",
"project.screen",
"project.screen.version",
"project.spacing_token",
"project.text_style",
"styleguide.*",
"styleguide.color",
"styleguide.component",
"styleguide.member",
"styleguide.spacing_token",
"styleguide.text_style",
"workspace.*",
"workspace.project",
"workspace.styleguide",
"workspace.organization",
"workspace.organization.member"
]
},
"description": "The events of the webhook"
},
"name": {
"type": "string",
"description": "The name of the webhook"
},
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The project ids of the webhook"
},
"secret": {
"type": "string",
"description": "The secret to be used to generate signatures for webhook requests"
},
"status": {
"type": "string",
"description": "The status of the webhook",
"enum": [
"active",
"inactive"
]
},
"styleguide_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The styleguide ids of the webhook"
},
"url": {
"type": "string",
"description": "The URL of the webhook"
}
},
"required": [
"PCID",
"organization_id",
"webhook_id"
]
}
zeplin_admin_update_project
Update a project Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
project_id | string | Yes | — | Project id | |
description | string | No | — | New description for the project | |
linked_styleguide_id | string | null | No | — | The unique id of the styleguide to be linked. Set null to unlink the linked styleguide. |
name | string | No | — | New name for the project | |
workflow_status_id | string | No | — | Id of the new workflow status for the project |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project id"
},
"description": {
"type": "string",
"description": "New description for the project"
},
"linked_styleguide_id": {
"type": [
"string",
"null"
],
"description": "The unique id of the styleguide to be linked. Set null to unlink the linked styleguide."
},
"name": {
"type": "string",
"description": "New name for the project"
},
"workflow_status_id": {
"type": "string",
"description": "Id of the new workflow status for the project"
}
},
"required": [
"PCID",
"project_id"
]
}
zeplin_admin_update_project_webhooks
Update project webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project_id | string | Yes | — | Project id |
webhook_id | string | Yes | — | Webhook id |
events | string[] | No | — | The events of the webhook |
name | string | No | — | The name of the webhook |
secret | string | No | — | The secret to be used to generate signatures for webhook requests |
status | string | No | — | The status of the webhook |
url | string | No | — | The URL of the webhook |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"project_id": {
"type": "string",
"description": "Project id"
},
"webhook_id": {
"type": "string",
"description": "Webhook id"
},
"events": {
"type": "array",
"items": {
"type": "string",
"enum": [
"project.*",
"project.color",
"project.component",
"project.member",
"project.note",
"project.note.comment",
"project.note.comment.reaction",
"project.screen",
"project.screen.version",
"project.spacing_token",
"project.text_style",
"project.flow_board"
]
},
"description": "The events of the webhook"
},
"name": {
"type": "string",
"description": "The name of the webhook"
},
"secret": {
"type": "string",
"description": "The secret to be used to generate signatures for webhook requests"
},
"status": {
"type": "string",
"description": "The status of the webhook",
"enum": [
"active",
"inactive"
]
},
"url": {
"type": "string",
"description": "The URL of the webhook"
}
},
"required": [
"PCID",
"project_id",
"webhook_id"
]
}
zeplin_admin_update_styleguide_webhooks
Update styleguide webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
styleguide_id | string | Yes | — | Styleguide id |
webhook_id | string | Yes | — | Webhook id |
events | string[] | No | — | The events of the webhook |
name | string | No | — | The name of the webhook |
secret | string | No | — | The secret to be used to generate signatures for webhook requests |
status | string | No | — | The status of the webhook |
url | string | No | — | The URL of the webhook |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"styleguide_id": {
"type": "string",
"description": "Styleguide id"
},
"webhook_id": {
"type": "string",
"description": "Webhook id"
},
"events": {
"type": "array",
"items": {
"type": "string",
"enum": [
"styleguide.*",
"styleguide.color",
"styleguide.component",
"styleguide.member",
"styleguide.spacing_token",
"styleguide.text_style"
]
},
"description": "The events of the webhook"
},
"name": {
"type": "string",
"description": "The name of the webhook"
},
"secret": {
"type": "string",
"description": "The secret to be used to generate signatures for webhook requests"
},
"status": {
"type": "string",
"description": "The status of the webhook",
"enum": [
"active",
"inactive"
]
},
"url": {
"type": "string",
"description": "The URL of the webhook"
}
},
"required": [
"PCID",
"styleguide_id",
"webhook_id"
]
}
zeplin_admin_update_user_notification
Update user notification Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
notification_id | string | Yes | — | Notification id |
is_read | boolean | Yes | — | New is_read status for notifications |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"notification_id": {
"type": "string",
"description": "Notification id"
},
"is_read": {
"type": "boolean",
"description": "New is_read status for notifications"
}
},
"required": [
"PCID",
"notification_id",
"is_read"
]
}
zeplin_admin_update_user_notifications
Bulk update user notifications Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | string[] | No | — | Filter by type Example: ?type=project.extension&type=styleguide.extension |
id | string[] | No | — | Filter by id Example: ?id=5fbe387f8c72ef23659fb500&id=602281f4783f72fccc045484 |
is_read | boolean | Yes | — | New is_read status for notifications |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"type": {
"type": "array",
"items": {
"type": "string",
"enum": [
"workspace.project",
"workspace.styleguide",
"project.extension",
"styleguide.extension",
"user.project_membership",
"user.styleguide_membership",
"project.component",
"styleguide.component",
"project.color",
"styleguide.color",
"project.screen.note",
"project.screen.note.comment",
"project.screen",
"project.text_style",
"styleguide.text_style",
"project.spacing_token",
"styleguide.spacing_token",
"project.jira_attachment",
"project.screen_section.jira_attachment",
"project.screen.jira_attachment",
"workspace.organization.member",
"project.slack_integration",
"styleguide.slack_integration",
"project.member",
"styleguide.member",
"project.flow_board"
]
},
"description": "Filter by type Example: `?type=project.extension&type=styleguide.extension`"
},
"id": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter by id Example: `?id=5fbe387f8c72ef23659fb500&id=602281f4783f72fccc045484`"
},
"is_read": {
"type": "boolean",
"description": "New is_read status for notifications"
}
},
"required": [
"PCID",
"is_read"
]
}
zeplin_admin_update_user_webhooks
Update user webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhook_id | string | Yes | — | Webhook id |
events | string[] | No | — | The events of the webhook |
name | string | No | — | The name of the webhook |
project_ids | string[] | No | — | The project ids of the webhook |
secret | string | No | — | The secret to be used to generate signatures for webhook requests |
status | string | No | — | The status of the webhook |
styleguide_ids | string[] | No | — | The styleguide ids of the webhook |
url | string | No | — | The URL of the webhook |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"webhook_id": {
"type": "string",
"description": "Webhook id"
},
"events": {
"type": "array",
"items": {
"type": "string",
"enum": [
"*",
"project.*",
"project.color",
"project.component",
"project.member",
"project.note",
"project.note.comment",
"project.note.comment.reaction",
"project.screen",
"project.screen.version",
"project.spacing_token",
"project.text_style",
"styleguide.*",
"styleguide.color",
"styleguide.component",
"styleguide.member",
"styleguide.spacing_token",
"styleguide.text_style",
"workspace.*",
"workspace.notification",
"workspace.project",
"workspace.styleguide"
]
},
"description": "The events of the webhook"
},
"name": {
"type": "string",
"description": "The name of the webhook"
},
"project_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The project ids of the webhook"
},
"secret": {
"type": "string",
"description": "The secret to be used to generate signatures for webhook requests"
},
"status": {
"type": "string",
"description": "The status of the webhook",
"enum": [
"active",
"inactive"
]
},
"styleguide_ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "The styleguide ids of the webhook"
},
"url": {
"type": "string",
"description": "The URL of the webhook"
}
},
"required": [
"PCID",
"webhook_id"
]
}

