Skip to Content
APIResourcesAdmin APIWebhook Registrations

Webhook Registrations

The Webhook Registrations resource allows you to register webhook endpoints via the MarkUp.io API.

Create webhook registration

POST /api/v2/webhook-registrations

POST /api/v2/webhook-registrations
curl "https://api.markup.io/api/v2/webhook-registrations" \
    -X POST \
    -H "Authorization: Bearer <API-KEY-SECRET>" \
    -H "Markup-API-Version: 2023-02-22" \
    -H "Content-Type: application/json" \
	--data '{
    "url": "https://markup.io",
    "workspaceId": "1389e598-1d99-4793-8429-891de5228d19",
    "eventTypes": [
        "comment_created",
        "comment_resolved"
    ],
    "enabled": true
}'
200 OK
{
  "data": {
    "id": "67b98bdc-3fce-4261-822f-66e22ee77199",
    "createdAt": "2026-07-23T17:45:55.657Z",
    "modifiedAt": "2026-07-23T17:45:55.657Z",
    "url": "https://markup.io",
    "workspaceId": "123e4567-e89b-12d3-a456-426655440000",
    "eventTypes": [
      "comment_created",
      "comment_resolved"
    ],
    "enabled": true
  }
}

Response Body - WebhookRegistrationResponse

Request Body CreateWebhookRegistrationRequest

OptionType
url string
workspaceId string
eventTypes optional
enabled boolean

Update webhook registration

POST /api/v2/webhook-registrations/:id

POST /api/v2/webhook-registrations/:id
curl "https://api.markup.io/api/v2/webhook-registrations/78409d40-d1da-436d-ad4c-ba454ae930a4" \
    -X POST \
    -H "Authorization: Bearer <API-KEY-SECRET>" \
    -H "Markup-API-Version: 2023-02-22" \
    -H "Content-Type: application/json" \
	--data '{
    "url": "https://markup.io",
    "eventTypes": [
        "comment_created",
        "comment_resolved"
    ],
    "enabled": true
}'
200 OK
{
  "data": {
    "id": "14bf5dac-6c1c-486a-a9e4-cf0f76d76d5b",
    "createdAt": "2026-07-23T17:45:55.657Z",
    "modifiedAt": "2026-07-23T17:45:55.657Z",
    "url": "https://markup.io",
    "workspaceId": "123e4567-e89b-12d3-a456-426655440000",
    "eventTypes": [
      "comment_created",
      "comment_resolved"
    ],
    "enabled": true
  }
}

Response Body - WebhookRegistrationResponse

Request Path Params IdRequestParam

OptionType
id string

Request Body UpdateWebhookRegistrationRequest

OptionType
url string
eventTypes optional
enabled boolean

Refresh webhook signing key

POST /api/v2/webhook-registrations/:id/refresh-signing-key

POST /api/v2/webhook-registrations/:id/refresh-signing-key
curl "https://api.markup.io/api/v2/webhook-registrations/54d996b4-3f6d-467e-bc1a-3f59359d31d6/refresh-signing-key" \
    -X POST \
    -H "Authorization: Bearer <API-KEY-SECRET>" \
    -H "Markup-API-Version: 2023-02-22" \
    -H "Content-Type: application/json"
200 OK
{
  "data": {
    "id": "7ddae072-e0fe-4d71-a70c-e326c1a34b5e",
    "createdAt": "2026-07-23T17:45:55.657Z",
    "modifiedAt": "2026-07-23T17:45:55.657Z",
    "url": "https://markup.io",
    "workspaceId": "123e4567-e89b-12d3-a456-426655440000",
    "eventTypes": [
      "comment_created",
      "comment_resolved"
    ],
    "enabled": true
  }
}

Response Body - WebhookRegistrationResponse

Request Path Params IdRequestParam

OptionType
id string

Get webhook registration

GET /api/v2/webhook-registrations/:id

GET /api/v2/webhook-registrations/:id
curl "https://api.markup.io/api/v2/webhook-registrations/cb735d4e-7f33-4869-a60c-f6500eba3dea" \
    -X GET \
    -H "Authorization: Bearer <API-KEY-SECRET>" \
    -H "Markup-API-Version: 2023-02-22" \
    -H "Content-Type: application/json"
200 OK
{
  "data": {
    "id": "6d206c08-92d9-4421-89c1-1928827c06f3",
    "createdAt": "2026-07-23T17:45:55.657Z",
    "modifiedAt": "2026-07-23T17:45:55.657Z",
    "url": "https://markup.io",
    "workspaceId": "123e4567-e89b-12d3-a456-426655440000",
    "eventTypes": [
      "comment_created",
      "comment_resolved"
    ],
    "enabled": true
  }
}

Response Body - WebhookRegistrationResponse

Request Path Params IdRequestParam

OptionType
id string

List webhook registrations

GET /api/v2/webhook-registrations

GET /api/v2/webhook-registrations
curl "https://api.markup.io/api/v2/webhook-registrations?workspaceId=a762fc3b-f946-4d8d-b37b-560b8ac1eb67" \
    -X GET \
    -H "Authorization: Bearer <API-KEY-SECRET>" \
    -H "Markup-API-Version: 2023-02-22" \
    -H "Content-Type: application/json"
200 OK
{
  "data": {
    "data": [
      {}
    ]
  }
}

Response Body ListWebhookRegistrationResponse

OptionType
data T[]

Request Query Params WorkspaceIdRequest

OptionType
workspaceId string

Delete webhook registration

DELETE /api/v2/webhook-registrations/:id

DELETE /api/v2/webhook-registrations/:id
curl "https://api.markup.io/api/v2/webhook-registrations/afc0e430-3feb-492e-8fa6-4b37da18cb52" \
    -X DELETE \
    -H "Authorization: Bearer <API-KEY-SECRET>" \
    -H "Markup-API-Version: 2023-02-22" \
    -H "Content-Type: application/json"
Response
204 No Content

Request Path Params IdRequestParam

OptionType
id string

WebhookRegistrationResponse

OptionType
id string
createdAt Iso8601Timestamp
modifiedAt Iso8601Timestamp
deletedAt Iso8601Timestamp
url string
workspaceId string
eventTypes
enabled boolean
signingKey string

WebhookEventType

OptionType
WebhookEventType `comment_created` | `comment_updated` | `comment_screenshot_failed` | `comment_resolved` | `comment_unresolved` | `markup_created` | `comment_reply_created` | `markup_status_changed` | `set_project_read_only` | `project_review_created`
Last updated on
Workspace UsersWorkspace