Skip to content

Event Catalog

Event Types

Subscribe to specific events or use * to receive all events.

EventDescription
link.createdA new short link was created
link.updatedA short link was modified
link.deletedA short link was deleted
link.scannedA short link or QR code was scanned
link.thresholdA link reached a scan count milestone
bio.publishedA Link-in-Bio page was published
bio.unpublishedA Link-in-Bio page was unpublished
asset.uploadedAn asset upload was confirmed
subscription.updatedThe workspace plan changed
test.pingTest event sent from the dashboard

Payload Schemas

link.created

{
"event": "link.created",
"timestamp": "2026-03-21T10:30:00Z",
"data": {
"link_id": "550e8400-e29b-41d4-a716-446655440000",
"short_code": "my-link",
"destination": "https://example.com"
}
}

link.updated

{
"event": "link.updated",
"timestamp": "2026-03-21T10:35:00Z",
"data": {
"link_id": "550e8400-e29b-41d4-a716-446655440000",
"short_code": "my-link",
"changes": {
"destination": "https://new-example.com",
"enabled": false
}
}
}

link.deleted

{
"event": "link.deleted",
"timestamp": "2026-03-21T10:40:00Z",
"data": {
"link_id": "550e8400-e29b-41d4-a716-446655440000",
"short_code": "my-link"
}
}

link.scanned

{
"event": "link.scanned",
"timestamp": "2026-03-21T10:45:00Z",
"data": {
"link_id": "550e8400-e29b-41d4-a716-446655440000",
"short_code": "my-link",
"country": "US",
"device": "mobile",
"browser": "Chrome",
"ip": "203.0.113.42"
}
}

link.threshold

{
"event": "link.threshold",
"timestamp": "2026-03-21T11:00:00Z",
"data": {
"link_id": "550e8400-e29b-41d4-a716-446655440000",
"short_code": "my-link",
"scan_count": 1000,
"threshold": 1000
}
}

bio.published

{
"event": "bio.published",
"timestamp": "2026-03-21T12:00:00Z",
"data": {
"page_id": "660e8400-e29b-41d4-a716-446655440000",
"title": "My Bio Page",
"slug": "johndoe",
"html_url": "https://xqr.bio/johndoe"
}
}

bio.unpublished

{
"event": "bio.unpublished",
"timestamp": "2026-03-21T12:30:00Z",
"data": {
"page_id": "660e8400-e29b-41d4-a716-446655440000",
"title": "My Bio Page",
"slug": "johndoe"
}
}

asset.uploaded

{
"event": "asset.uploaded",
"timestamp": "2026-03-21T13:00:00Z",
"data": {
"asset_id": "770e8400-e29b-41d4-a716-446655440000",
"filename": "logo.png",
"mime_type": "image/png",
"file_size": 24576
}
}

subscription.updated

{
"event": "subscription.updated",
"timestamp": "2026-03-21T14:00:00Z",
"data": {
"previous_plan": "pro",
"new_plan": "business",
"effective_at": "2026-04-01T00:00:00Z"
}
}

test.ping

{
"event": "test.ping",
"timestamp": "2026-03-21T15:00:00Z",
"data": {
"message": "This is a test webhook delivery."
}
}

Was this page helpful?