API
Webhooks

Webhooks

MarkUp.io uses webhooks to notify external applications when events happen. For example you could notify a task management app when someone leaves a new comment in a Markup. The events available are:

EventEvent Type
Comment Resolvedcomment_resolved
Comment Unresolvedcomment_created
Comment Createdcomment_unresolved
Markup Createdmarkup_created
Reply Createdcomment_reply_created

Notification events

MarkUp Created

Triggered when a new Markup is created.

Example

Example - Comment resolved
{
    "webhookUrl": "https://example.com/webhook",
    "id": "ce10f176-6a68-42eb-9ce2-718aae4ba191",
    "type": "markup_created",
    "workspaceId": "355fe681-10d5-489e-8964-41b812d1d0fe",
    "createdAt": "2023-02-15T20:41:54.137Z",
    "data": {
      "markup": {
        "id": "ce10f176-6a68-42eb-9ce2-718aae4ba191",
        "createdAt": "2023-02-15T20:41:54.137Z",
        "modifiedAt": "2023-02-15T20:41:54.137Z",
        "thumbnailUrl": "https://images.markup.io/green/project-images/9dfee13a-42ef-4396-b564-e865e835e33f",
        "name": "markup.io",
        "webpageUrl": "https://markup.io",
        "commentingUrl": "https://app.markup.io/markup/ce10f176-6a68-42eb-9ce2-718aae4ba191",
        "appUrl": "https://app.markup.io/markup/ce10f176-6a68-42eb-9ce2-718aae4ba191",
        "workspaceId": "355fe681-10d5-489e-8964-41b812d1d0fe",
        "lastActivityAt": "2023-02-15T20:41:54.137Z",
        "parentFolderId": "6a6360e6-fb79-416a-b765-6667f380b98e"
      },
      "user": {
         "id": "ce10f176-6a68-42eb-9ce2-718aae4ba191",
         "createdAt": "2023-02-15T20:41:54.137Z",
         "modifiedAt": "2023-02-15T20:41:54.137Z",
         "name": "John Doe",
         "email": "[email protected]"
      }
    }
 }
}

Parameters

OptionType
id string
webhookUrl string
type 'comment_resolved'
workspaceId string
data.markup
data.user

Comment Created

Triggered when a comment is created within a Markup.

Example

Example - Comment resolved
{
    "webhookUrl": "https://example.com/webhook",
    "id": "ce10f176-6a68-42eb-9ce2-718aae4ba191",
    "type": "comment_created",
    "workspaceId": "355fe681-10d5-489e-8964-41b812d1d0fe",
    "createdAt": "2023-02-15T20:41:54.137Z",
    "data": {
      "markup": {
        "id": "ce10f176-6a68-42eb-9ce2-718aae4ba191",
        "createdAt": "2023-02-15T20:41:54.137Z",
        "modifiedAt": "2023-02-15T20:41:54.137Z",
        "thumbnailUrl": "https://images.markup.io/green/project-images/9dfee13a-42ef-4396-b564-e865e835e33f",
        "name": "markup.io",
        "webpageUrl": "https://markup.io",
        "commentingUrl": "https://app.markup.io/markup/ce10f176-6a68-42eb-9ce2-718aae4ba191",
        "appUrl": "https://app.markup.io/markup/ce10f176-6a68-42eb-9ce2-718aae4ba191",
        "workspaceId": "355fe681-10d5-489e-8964-41b812d1d0fe",
        "lastActivityAt": "2023-02-15T20:41:54.137Z",
        "parentFolderId": "6a6360e6-fb79-416a-b765-6667f380b98e"
      },
      "user": {
         "id": "ce10f176-6a68-42eb-9ce2-718aae4ba191",
         "createdAt": "2023-02-15T20:41:54.137Z",
         "modifiedAt": "2023-02-15T20:41:54.137Z",
         "name": "John Doe",
         "email": "[email protected]"
      },
      "comment": {
         "createdAt": "2023-02-16T10:01:26.830Z",
         "modifiedAt": "2023-02-16T10:01:26.830Z",
         "id": "dca005c2-0c69-4166-aae1-27ec76db94ef",
         "firstMessage": {
            "createdAt": "2023-02-16T10:01:26.830Z",
            "modifiedAt": "2023-02-16T10:01:26.830Z",
            "id": "71734093-b557-46cf-8678-a028fbe6a8c8",
            "text": "Could you change the color of the button to red?",
            "attachments": []
         },
          "resolved": true,
          "appUrl": "https://app.markup.io/markup/ce10f176-6a68-42eb-9ce2-718aae4ba191/#thread/dca005c2-0c69-4166-aae1-27ec76db94ef",
          "messageCount": 1
       }
    }
 }
}

Comment Resolved

Triggered when a comment is resolved within a Markup.

Example

Example - Comment resolved
{
    "webhookUrl": "https://example.com/webhook",
    "id": "ce10f176-6a68-42eb-9ce2-718aae4ba191",
    "type": "comment_resolved",
    "workspaceId": "355fe681-10d5-489e-8964-41b812d1d0fe",
    "createdAt": "2023-02-15T20:41:54.137Z",
    "data": {
      "markup": {
        "id": "ce10f176-6a68-42eb-9ce2-718aae4ba191",
        "createdAt": "2023-02-15T20:41:54.137Z",
        "modifiedAt": "2023-02-15T20:41:54.137Z",
        "thumbnailUrl": "https://images.markup.io/green/project-images/9dfee13a-42ef-4396-b564-e865e835e33f",
        "name": "markup.io",
        "webpageUrl": "https://markup.io",
        "commentingUrl": "https://app.markup.io/markup/ce10f176-6a68-42eb-9ce2-718aae4ba191",
        "appUrl": "https://app.markup.io/markup/ce10f176-6a68-42eb-9ce2-718aae4ba191",
        "workspaceId": "355fe681-10d5-489e-8964-41b812d1d0fe",
        "lastActivityAt": "2023-02-15T20:41:54.137Z",
        "parentFolderId": "6a6360e6-fb79-416a-b765-6667f380b98e"
      },
      "user": {
         "id": "ce10f176-6a68-42eb-9ce2-718aae4ba191",
         "createdAt": "2023-02-15T20:41:54.137Z",
         "modifiedAt": "2023-02-15T20:41:54.137Z",
         "name": "John Doe",
         "email": "[email protected]"
      },
      "comment": {
         "createdAt": "2023-02-16T10:01:26.830Z",
         "modifiedAt": "2023-02-16T10:01:26.830Z",
         "id": "dca005c2-0c69-4166-aae1-27ec76db94ef",
         "firstMessage": {
            "createdAt": "2023-02-16T10:01:26.830Z",
            "modifiedAt": "2023-02-16T10:01:26.830Z",
            "id": "71734093-b557-46cf-8678-a028fbe6a8c8",
            "text": "Could you change the color of the button to red?",
            "attachments": []
         },
          "resolved": true,
          "appUrl": "https://app.markup.io/markup/ce10f176-6a68-42eb-9ce2-718aae4ba191/#thread/dca005c2-0c69-4166-aae1-27ec76db94ef",
          "messageCount": 1
       }
    }
 }
}

Parameters

OptionType
id string
webhookUrl string
type 'comment_resolved'
workspaceId string
data.markup
data.user
data.comment

Comment Unresolved

Triggered when a comment is unresolved within a Markup.

Example

Example content - Comment resolved
{
    "webhookUrl": "https://example.com/webhook",
    "id": "ce10f176-6a68-42eb-9ce2-718aae4ba191",
    "type": "comment_unresolved",
    "workspaceId": "355fe681-10d5-489e-8964-41b812d1d0fe",
    "createdAt": "2023-02-15T20:41:54.137Z",
    "data": {
      "markup": {
        "id": "ce10f176-6a68-42eb-9ce2-718aae4ba191",
        "createdAt": "2023-02-15T20:41:54.137Z",
        "modifiedAt": "2023-02-15T20:41:54.137Z",
        "thumbnailUrl": "https://images.markup.io/green/project-images/9dfee13a-42ef-4396-b564-e865e835e33f",
        "name": "markup.io",
        "webpageUrl": "https://markup.io",
        "commentingUrl": "https://app.markup.io/markup/ce10f176-6a68-42eb-9ce2-718aae4ba191",
        "appUrl": "https://app.markup.io/markup/ce10f176-6a68-42eb-9ce2-718aae4ba191",
        "workspaceId": "355fe681-10d5-489e-8964-41b812d1d0fe",
        "lastActivityAt": "2023-02-15T20:41:54.137Z",
        "parentFolderId": "6a6360e6-fb79-416a-b765-6667f380b98e"
      },
      "user": {
         "id": "ce10f176-6a68-42eb-9ce2-718aae4ba191",
         "createdAt": "2023-02-15T20:41:54.137Z",
         "modifiedAt": "2023-02-15T20:41:54.137Z",
         "name": "John Doe",
         "email": "[email protected]"
      },
      "comment": {
         "createdAt": "2023-02-16T10:01:26.830Z",
         "modifiedAt": "2023-02-16T10:01:26.830Z",
         "id": "dca005c2-0c69-4166-aae1-27ec76db94ef",
         "firstMessage": {
            "createdAt": "2023-02-16T10:01:26.830Z",
            "modifiedAt": "2023-02-16T10:01:26.830Z",
            "id": "71734093-b557-46cf-8678-a028fbe6a8c8",
            "text": "Could you change the color of the button to red?",
            "attachments": []
         },
          "resolved": false,
          "appUrl": "https://app.markup.io/markup/ce10f176-6a68-42eb-9ce2-718aae4ba191/#thread/dca005c2-0c69-4166-aae1-27ec76db94ef",
          "messageCount": 1
       }
    }
 }
}

Parameters

OptionType
id string
webhookUrl string
type 'comment_unresolved'
workspaceId string
data.markup
data.user
data.comment

Comment Reply Created

Triggered when a reply is created within a comment.

Example

Example content - Reply resolved
{
    "webhookUrl": "https://example.com/webhook",
    "id": "ce10f176-6a68-42eb-9ce2-718aae4ba191",
    "type": "comment_reply_created",
    "workspaceId": "355fe681-10d5-489e-8964-41b812d1d0fe",
    "createdAt": "2023-02-15T20:41:54.137Z",
    "data": {
      "message" : {
        "message": {
         "createdAt": "2023-02-16T10:11:15.711Z",
         "modifiedAt": "2023-02-16T10:11:15.711Z",
         "id": "4fefda85-192f-43cf-8d4b-e909c8e475d5",
         "text": "Yes of course!",
         "attachments": []
       }
      },
      "markup": {
        "id": "ce10f176-6a68-42eb-9ce2-718aae4ba191",
        "createdAt": "2023-02-15T20:41:54.137Z",
        "modifiedAt": "2023-02-15T20:41:54.137Z",
        "thumbnailUrl": "https://images.markup.io/green/project-images/9dfee13a-42ef-4396-b564-e865e835e33f",
        "name": "markup.io",
        "webpageUrl": "https://markup.io",
        "commentingUrl": "https://app.markup.io/markup/ce10f176-6a68-42eb-9ce2-718aae4ba191",
        "appUrl": "https://app.markup.io/markup/ce10f176-6a68-42eb-9ce2-718aae4ba191",
        "workspaceId": "355fe681-10d5-489e-8964-41b812d1d0fe",
        "lastActivityAt": "2023-02-15T20:41:54.137Z",
        "parentFolderId": "6a6360e6-fb79-416a-b765-6667f380b98e"
      },
      "user": {
         "id": "ce10f176-6a68-42eb-9ce2-718aae4ba191",
         "createdAt": "2023-02-15T20:41:54.137Z",
         "modifiedAt": "2023-02-15T20:41:54.137Z",
         "name": "John Doe",
         "email": "[email protected]"
      },
      "comment": {
         "createdAt": "2023-02-16T10:01:26.830Z",
         "modifiedAt": "2023-02-16T10:01:26.830Z",
         "id": "dca005c2-0c69-4166-aae1-27ec76db94ef",
         "firstMessage": {
            "createdAt": "2023-02-16T10:01:26.830Z",
            "modifiedAt": "2023-02-16T10:01:26.830Z",
            "id": "71734093-b557-46cf-8678-a028fbe6a8c8",
            "text": "Could you change the color of the button to red?",
            "attachments": []
         },
          "resolved": false,
          "appUrl": "https://app.markup.io/markup/ce10f176-6a68-42eb-9ce2-718aae4ba191/#thread/dca005c2-0c69-4166-aae1-27ec76db94ef",
          "messageCount": 1
       }
    }
 }
}

Parameters

OptionType
id string
webhookUrl string
type 'comment_reply_created'
workspaceId string
data.markup
data.user
data.comment

Related types

MarkupNotification

OptionType
id string
createdAt Iso8601Timestamp
modifiedAt Iso8601Timestamp
deletedAt optionalIso8601Timestamp
webpageUrl optionalstring
name string
thumbnailUrl string
appUrl string
workspaceId string
parentFolderId string
commentingUrl string

UserNotification

OptionType
id string
createdAt Iso8601Timestamp
modifiedAt Iso8601Timestamp
deletedAt optionalIso8601Timestamp
name string
email optionalstring
guest boolean
avatarUrl optionalstring

CommentNotification

OptionType
id string
createdAt Iso8601Timestamp
modifiedAt Iso8601Timestamp
deletedAt optionalIso8601Timestamp
resolved boolean
firstMessage
appUrl string
messageCount number
screenshot optional

MessageNotification

OptionType
id string
createdAt Iso8601Timestamp
modifiedAt Iso8601Timestamp
deletedAt optionalIso8601Timestamp
text string
attachments optional
screenshot optional

MessageScreenshotNotification

OptionType
id string
createdAt Iso8601Timestamp
modifiedAt Iso8601Timestamp
deletedAt optionalIso8601Timestamp
url string
etag string
mimeType string
width number
height number
filesize number
type `extension`|`native`

MessageAttachmentNotification

OptionType
id string
createdAt Iso8601Timestamp
modifiedAt Iso8601Timestamp
deletedAt optionalIso8601Timestamp
url string
etag string
mimeType string
originalFilename string
filesize number
Webhook Registrations