Link created (link.created)
Description
Triggered when a new short link is created (destination URL, domain/path, behaviors, UTM tags, and social preview metadata).
Payload structure
{
"eventId": "string (uuid)",
"eventType": "link.created",
"timestamp": "string (ISO-8601)",
"schemaVersion": 1,
"payload": {}
}
Fields
Root (envelope)
| Field | Type | Description |
|---|---|---|
| eventId | string | Unique identifier for this webhook delivery. |
| eventType | string | Always link.created for this event. |
| timestamp | string | Time the event was emitted. |
| schemaVersion | number | Version of schema. |
| payload | object | Link definition and metadata. |
Payload object (payload)
| Field | Type | Description |
|---|---|---|
| shortUrl | string | Short URL including scheme. |
| domain | string | Host portion of the short link. |
| path | string | Path/slug segment of the short link. |
| destinationUrl | string | Target URL users resolve to. |
| iosBehavior | string | iOS handling mode (for example browser). |
| androidBehavior | string | Android handling mode (for example browser). |
| isEnabled | boolean | Whether the link is active. |
| utm | object | UTM parameters attached to the link (see below). |
| social | object | Social preview metadata (see below). |
| createdBy | string | Creator identifier or label (for example api_user). |
| createdAt | string | Creation timestamp string. |
| modifiedAt | string | Last modification timestamp string. |
| eventId | string | Duplicate of root eventId (see Notes). |
| timestamp | string | Duplicate of root timestamp. |
| schemaVersion | number | Duplicate of root schemaVersion. |
| eventType | string | Duplicate of root eventType. |
payload.utm
| Field | Type | Description |
|---|---|---|
| utm_source | string | utm_source value (may be empty string). |
| utm_medium | string | utm_medium value. |
| utm_campaign | string | utm_campaign value. |
| utm_term | string | utm_term value. |
| utm_content | string | utm_content value. |
payload.social
| Field | Type | Description |
|---|---|---|
| title | string | Social/share title. |
| description | string | Social/share description. |
| imageUrl | string | Preview image URL (may be empty string). |
Example payload
{
"eventId": "b1278bd8-ba58-4945-b3b0-a6bcc6e11614",
"eventType": "link.created",
"schemaVersion": 1,
"timestamp": "2026-04-29T13:12:22.446763",
"payload": {
"shortUrl": "https://zeustechnology.trycleansify.com/renewable",
"domain": "zeustechnology.trycleansify.com",
"path": "renewable",
"destinationUrl": "https://www.ireda.in/home",
"iosBehavior": "browser",
"androidBehavior": "browser",
"isEnabled": true,
"utm": {
"utm_source": "",
"utm_medium": "ireda_camp",
"utm_campaign": "indian-renewable-energy-apr2026",
"utm_term": "email+blog",
"utm_content": "image_top_banner"
},
"social": {
"title": "Indian Renewable Energy Development Agency Limited",
"description": "Once IREDA, Always IREDA",
"imageUrl": ""
},
"createdBy": "api_user",
"createdAt": "2026-04-29T13:12:22.432724",
"modifiedAt": "2026-04-29T13:12:22.432733",
"eventId": "b1278bd8-ba58-4945-b3b0-a6bcc6e11614",
"timestamp": "2026-04-29T13:12:22.446763",
"schemaVersion": 1,
"eventType": "link.created"
}
}
Notes
- The
payloadobject repeatseventId,timestamp,schemaVersion, andeventTypeat the same values as the root envelope. Consumers may read either layer; prefer the root envelope for routing and deduplication unless your pipeline relies on the nested copies.