Platform

July 28, 2026 ยท View on GitHub

Metadata about the source platform that triggered the deployment. Allows us to map a deployment back to a platform (e.g. the chat that created it)

Example Usage

import { Platform } from "@vercel/sdk/models/canceldeploymentresponsebody.js";

let value: Platform = {
  source: {
    name: "<value>",
  },
  origin: {
    type: "url",
    value: "<value>",
  },
  creator: {
    name: "<value>",
  },
};

Fields

FieldTypeRequiredDescription
sourcemodels.CancelDeploymentDeploymentsSource:heavy_check_mark:The external platform that created the deployment (e.g. its display name).
originmodels.CancelDeploymentOrigin:heavy_check_mark:Reference back to the entity on the platform that initiated the deployment.
creatormodels.CancelDeploymentDeploymentsCreator:heavy_check_mark:The user on the external platform who triggered the deployment.
metaRecord<string, string>:heavy_minus_sign:Arbitrary key-value metadata provided by the platform.