Generate LiveSend link
Name: generate_livesend_link
Description: Generates a LiveSend link with configurable settings and provided contents, enabling controlled sharing and engagement tracking.
Schema
{
"type": "object",
"properties": {
"contents": {
"type": "array",
"description": "A list of universal content IDs for the contents to be included in the LiveSend. \nThis field must not be null and should contain at least one item. Supported contents include \nDocCenter content and Workspace content in Seismic.\n- Workspace content: \n - Format: `Workspace__{Type}__{ContentId}__{VersionId}`\n - Example: `Workspace__File__0a584955-aea5-40b9-82a0-7310acb178d6__a85a14dc-964b-4fd3-b163-47b7474c1700`\n- DocCenter content: \n - Format: `ContentManager__{Type}__{ContentId}__{VersionId}__{TeamSiteId}`\n - Example: `ContentManager__File__c8d89fb3-0f18-4c9d-9721-fda7d983fbbc__ed90a0c5-5256-4ce8-a822-4a7259e163e8__3193b16d-9c2e-4422-b3e1-a8ecb1f40a51`",
"items": {
"type": "string"
}
},
"contexts": {
"type": "array",
"description": "Array of contexts of the relevant interaction.\nOptional.",
"items": {
"type": "object",
"properties": {
"contextId": {
"type": "string",
"example": "00646000009eMGL",
"description": "The id of the context the integrator is in. Typically the record id from the external system."
},
"contextName": {
"type": "string",
"example": "Edge Communications",
"description": "The name of the context. Typically this is the record name."
},
"contextType": {
"type": "string",
"example": "Opportunity",
"description": "The type or class of the context. Typically the record type such as Account, Contact, or Opportunity. This field is case sensitive."
},
"source": {
"type": "string",
"example": "seismic-embedded",
"description": "The name of the application or integration which collected the context.",
"enum": [
"seismic-contact-picker",
"seismic-embedded",
"seismic-attribution",
"seismic-aura",
"seismic-context-picker",
"seismic-ai"
]
},
"sourceType": {
"type": "string",
"example": "ambient",
"enum": [
"override",
"explicit",
"navigational",
"foreign-key",
"heuristic",
"ambient"
],
"description": "The type of the source."
},
"systemId": {
"type": "string",
"example": "00566547531rXYZ",
"description": "The id for the external system which is critical when the tenant can be connected to multiple instances of the same system (such as Salesforce or Dynamics)."
},
"systemType": {
"type": "string",
"example": "Salesforce",
"description": "The system type."
}
},
"required": [
"contextId",
"contextName",
"contextType",
"source",
"sourceType",
"systemId",
"systemType"
]
}
},
"recipients": {
"type": "array",
"description": "A list of recipients.\nOptional.",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The email address of the recipient.",
"example": "[email protected]"
},
"firstName": {
"type": "string",
"description": "The first name of the recipient.\nOptional.",
"example": "Michael"
},
"lastName": {
"type": "string",
"description": "The last name of the recipient.\nOptional.",
"example": "Brown"
},
"contexts": {
"type": "array",
"description": "Array of contexts specific to this recipient in the context of the relevant interaction.\nOptional.",
"items": {
"type": "object",
"properties": {
"contextEmail": {
"type": "string",
"example": "[email protected]",
"description": "The email address from the context, where appropriate."
},
"contextId": {
"type": "string",
"description": "The id of the context the integrator is in. Typically the record id from the external system.",
"example": "00646000009eMGL"
},
"contextName": {
"type": "string",
"example": "Edge Communications",
"description": "The name of the context. Typically this is the record name."
},
"contextType": {
"type": "string",
"example": "Opportunity",
"description": "The type or class of the context. Typically the record type such as Account, Contact, or Opportunity. This field is case sensitive."
},
"source": {
"type": "string",
"example": "seismic-embedded",
"description": "The name of the application or integration which collected the context.",
"enum": [
"seismic-contact-picker",
"seismic-embedded",
"seismic-attribution",
"seismic-aura",
"seismic-context-picker",
"seismic-ai"
]
},
"sourceType": {
"type": "string",
"description": "The type of the source.",
"example": "ambient",
"enum": [
"override",
"explicit",
"navigational",
"foreign-key",
"heuristic",
"ambient"
]
},
"systemId": {
"type": "string",
"description": "The id for the external system which is critical when the tenant can be connected to multiple instances of the same system (such as Salesforce or Dynamics).",
"example": "00566547531rXYZ"
},
"systemType": {
"type": "string",
"example": "Salesforce",
"description": "The system type."
}
},
"required": [
"contextId",
"contextName",
"contextType",
"source",
"sourceType",
"systemId",
"systemType"
]
}
}
},
"required": [
"email"
]
}
},
"settings": {
"type": [
"object",
"null"
],
"description": "The settings of the LiveSend link.\nOptional. If not set or assigned a null value, a system default value will be assigned.",
"properties": {
"expiresAt": {
"type": "string",
"format": "date-time",
"description": "The expiration date for the LiveSend link(in UTC time format).\nOptional. If not set or assigned a null value, a system default value will be assigned."
},
"password": {
"type": "string",
"description": "Password protection for the LiveSend link."
},
"allowDownload": {
"type": "boolean",
"description": "Indicates whether the viewers are allowed to download the content.\nOptional. If not set or assigned a null value, a system default value will be assigned."
},
"notificationType": {
"type": "string",
"enum": [
"None",
"Summary",
"All"
],
"description": "Notification type for LiveSend link sessions.\nOptional. If not set or assigned a null value, a system default value will be assigned."
}
}
}
},
"required": [
"contents"
]
}
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the created LiveSend."
},
"internalUrl": {
"type": "string",
"description": "The internal URL for accessing the LiveSend within Seismic Engagement Center."
},
"externalUrl": {
"type": "string",
"description": "The link URL for accessing the LiveSend."
}
},
"required": []
}
Updated 1 day ago