Skip to main content

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)

FieldTypeDescription
eventIdstringUnique identifier for this webhook delivery.
eventTypestringAlways link.created for this event.
timestampstringTime the event was emitted.
schemaVersionnumberVersion of schema.
payloadobjectLink definition and metadata.

Payload object (payload)

FieldTypeDescription
shortUrlstringShort URL including scheme.
domainstringHost portion of the short link.
pathstringPath/slug segment of the short link.
destinationUrlstringTarget URL users resolve to.
iosBehaviorstringiOS handling mode (for example browser).
androidBehaviorstringAndroid handling mode (for example browser).
isEnabledbooleanWhether the link is active.
utmobjectUTM parameters attached to the link (see below).
socialobjectSocial preview metadata (see below).
createdBystringCreator identifier or label (for example api_user).
createdAtstringCreation timestamp string.
modifiedAtstringLast modification timestamp string.
eventIdstringDuplicate of root eventId (see Notes).
timestampstringDuplicate of root timestamp.
schemaVersionnumberDuplicate of root schemaVersion.
eventTypestringDuplicate of root eventType.

payload.utm

FieldTypeDescription
utm_sourcestringutm_source value (may be empty string).
utm_mediumstringutm_medium value.
utm_campaignstringutm_campaign value.
utm_termstringutm_term value.
utm_contentstringutm_content value.

payload.social

FieldTypeDescription
titlestringSocial/share title.
descriptionstringSocial/share description.
imageUrlstringPreview 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 payload object repeats eventId, timestamp, schemaVersion, and eventType at 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.