Endpoints

[
  {
    "id": <identifier>,
    "message": <text>,
    "timestamp": <timestamp>,
    "type": <"stdout" or "stderr">,
    "source": <"build", "static", "external", or "lambda">,
    "projectId": <identifier of project>,
    "deploymentId": <identifier of deployement>,
    "buildId": <identifier of build>,
    "host": <hostname>,
    "entrypoint": <entrypoint>
  },
  {
    "id": <identifier>,
    "message": <text>,
    "timestamp": <timestamp>,
    "requestId": <identifier of request only on runtime logs>,
    "statusCode": <HTTP status code of request only on runtime logs>,
    "source": <"build", "static", "external", or "lambda">,
    "projectId": <identifier of project>,
    "deploymentId": <identifier of deployement>,
    "buildId": <identifier of build only on build logs>,
    "destination": <origin of external content only on external logs>,
    "host": <hostname>,
    "path": <path>,
    "proxy": {
      "timestamp": <timestamp of proxy request>,
      "method": <method of request>,
      "scheme": <protocol of request>,
      "host": <hostname>,
      "path": <path of proxy request>,
      "userAgent": <user agent>,
      "referer": <referer>,
      "statusCode": <HTTP status code of proxy request>,
      "clientIp": <client IP>,
      "region": <region request is processed>,
      "cacheId": <original request id when request is served from cache>,
      "errorCode": <error code happened on proxy request>,
    }
  }
]

{
  "id": "1573817187330377061717300000",
  "message": "done",
  "timestamp": 1573817187330,
  "type": "stdout",
  "source": "build",
  "projectId": "abcdefgdufoJxB6b9b1fEqr1jUtFkyavUURbnDCFCnZxgs",
  "deploymentId": "dpl_233NRGRjVZX1caZrXWtz5g1TAksD",
  "buildId": "bld_cotnkcr76",
  "host": "example-4lp0kffgq.vercel.app",
  "entrypoint": "api/index.js"
}

{
  "id": "1573817250283254651097202070",
  "message": "START RequestId: 643af4e3-975a-4cc7-9e7a-1eda11539d90 Version: $LATEST\\n2019-11-15T11:27:30.721Z\\t643af4e3-975a-4cc7-9e7a-1eda11539d90\\tINFO\\thello\\nEND RequestId: 643af4e3-975a-4cc7-9e7a-1eda11539d90\\nREPORT RequestId: 643af4e3-975a-4cc7-9e7a-1eda11539d90\\tDuration: 16.76 ms\\tBilled Duration: 100 ms\\tMemory Size: 1024 MB\\tMax Memory Used: 78 MB\\tInit Duration: 186.49 ms\\t\\n",
  "timestamp": 1573817250283,
  "source": "lambda",
  "requestId": "894xj-1573817250172-7847d20a4939",
  "statusCode": 200,
  "proxy": {
    "timestamp": 1573817250172,
    "path": "/api",
    "userAgent": [
      "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.97 Safari/537.36"
    ],
    "referer": "http://example.vercel.app",
    "method": "GET",
    "scheme": "https",
    "host": "example-4lp0kffgq.vercel.app",
    "statusCode": 200,
    "clientIp": "120.75.16.101",
    "region": "sfo1"
  },
  "projectId": "abcdefgdufoJxB6b9b1fEqr1jUtFkyavUURbnDCFCnZxgs",
  "deploymentId": "dpl_233NRGRjVZX1caZrXWtz5g1TAksD",
  "host": "example-4lp0kffgq.vercel.app",
  "path": "api/index.js"
}

425 <142>1 2019-11-15T11:42:22.562Z example-4lp0kffgq.vercel.app now proxy - [proxy@54735 requestId="q8k4w-1573818142562-9adfb40ce9d4" statusCode="200" method="GET" path="/api" userAgent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.97 Safari/537.36" referer="http://example.vercel.app" clientIp="120.75.16.101" region="sfo1" signature="b847f4dd531d0b41094fb4b38fd62bde0b0e29a5"]587 <150>1 2019-11-15T11:42:22.833Z example-4lp0kffgq.vercel.app now lambda - [lambda@54735 requestId="q8k4w-1573818142562-9adfb40ce9d4" statusCode="200" path="api/index.js" signature="0900101157dac2a2e555524c2f8d61229b15307d"] BOMSTART RequestId: ec00309f-4514-4128-8b8a-9a0e74900283 Version: $LATEST
2019-11-15T11:42:23.176Z\\tec00309f-4514-4128-8b8a-9a0e74900283\\tINFO\\thello
END RequestId: ec00309f-4514-4128-8b8a-9a0e74900283
REPORT RequestId: ec00309f-4514-4128-8b8a-9a0e74900283\\tDuration: 20.08 ms\\tBilled Duration: 100 ms Memory Size: 1024 MB\\tMax Memory Used: 77 MB\\tInit Duration: 157.97 ms

const http = require('http');
const crypto = require('crypto');
http
  .createServer((req, res) => {
    var body = '';
    req.on('data', function (chunk) {
      body += chunk;
    });
    req.on('end', function () {
      if (!verifySignature(req, body)) {
        res.statusCode = 403;
        res.end("signature didn't match");
        return;
      }
      res.end('ok');
    });
  })
  .listen(3000);
function verifySignature(req, body) {
  const signature = crypto
    .createHmac('sha1', process.env.OAUTH2_SECRET)
    .update(body)
    .digest('hex');
  return signature === req.headers['x-vercel-signature'];
}

Errors

Generic Errors

These error codes are consistent for all endpoints.

Forbidden

You're not authorized to use the endpoint. This usually happens due to missing an user token.

{
  "error": {
    "code": "forbidden",
    "message": "Not authorized"
  }
}

Rate Limited

You exceeded the maximum allotted requests.

The limit of request is per endpoint basis so you could continue using another endpoints even if some of them give you this error.

{
  "error": {
    "code": "rate_limited",
    "message": "The rate limit of 6 exceeded for 'api-www-user-update-username'. Try again in 7 days",
    "limit": {
      "remaining": 0,
      "reset": 1571432075,
      "resetMs": 1571432075563,
      "total": 6
    }
  }
}

Bad Request

There was an error with the request, the error.message would contain information about the issue.

{
  "error": {
    "code": "bad_request",
    "message": "An english description of the error that just occurred",
  }
}

Internal Server Error

This errors is similar to the HTTP 500 Internal Server Error error code.

{
  "error": {
    "code": "internal_server_error",
    "message": "An unexpected internal error occurred"
  }
}

Resource Not Found

The requested resource could not be found

{
  "error": {
    "code": "not_found",
    "message": "Could not find the RESOURCE: ID"
  }
}

Method Unknown

The endpoint you're requesting does not handle the method you defined. The error message will contain the methods the endpoint responds to.

{
  "error": {
    "code": "method_unknown",
    "message": "This endpoint only responds to METHOD"
  }
}

Deployment Errors

These error code could happen when using any deployment related endpoint.

Missing Files

Some of the files you defined when creating the deployment are missing.

{
  "error": {
    "code": "missing_files",
    "message": "Missing files",
    "missing": []
  }
}

No Files in the Deployment

You tried to create an empty deployment.

{
  "error": {
    "code": "no_files",
    "message": "No files in the deployment"
  }
}

Too Many Environment Variables

The limit of environment variables per deployment is 100 and you defined more. The error message indicates the amount you define.

{
  "error": {
    "code": "env_too_many_keys",
    "message": "Too many env vars have been supplied (100 max allowed, but got #)"
  }
}

Environment Variable Key with Invalid Characters

Some environment variable name contains an invalid character. The only valid characters are letters, digits and _.

The error message will contain the KEY with the problem.

{
  "error": {
    "code": "env_key_invalid_characters",
    "message": "The env key "KEY" contains invalid characters. Only letters, digits and `_` are allowed",
    "key": KEY
  }
}

Environment Variable Key with a Long Name

An environment variable name is too long, the maximum permitted name is 256 characters.

The error message contains the environment KEY.

{
  "error": {
    "code": "env_key_invalid_length",
    "message": "The env key "KEY" exceeds the 256 length limit",
    "key": KEY
  }
}

Environment Variable Value with a Long Name

An environment variable value contains a value too long, the maximum permitted value is 65536 characters.

The error message contains the environment KEY.

{
  "error": {
    "code": "env_value_invalid_length",
    "message": "The env value for "KEY" exceeds the 65536 length limit",
    "key": KEY,
    "value": VALUE
  }
}

Environment Variable Value Is an Object without UID

The value of an environment variable is object but it doesn't have a uid.

The error message contains the environment KEY which has the error.

{
  "error": {
    "code": "env_value_invalid_type_missing_uid",
    "message": "The env key "KEY" passed an object as a value with no `uid` key"
  }
}

Environment Variable Value Is an Object with Unknown Props

The value of an environment variable is an object with unknown attributes, it only can have a uid key inside the object.

{
  "error": {
    "code": "env_value_invalid_type_unknown_props",
    "message": "The env key "KEY" passed an object with unknown properties. Only `uid` is allowed when passing an object"
  }
}

Environment Variable Value with an Invalid Type

An environment variable value passed is of an unsupported type.

The error message contains the environment KEY.

{
  "error": {
    "code": "env_value_invalid_type",
    "message": "The env key "KEY" passed an unsupported type for its value",
    "key": KEY
  }
}

Not Allowed to Access a Secret

You're trying to use a secret but you don't have access to it.

{
  "error": {
    "code": "env_secret_forbidden",
    "message": "Not allowed to access secret \"NAME\"",
    "uid": UID
  }
}

Missing Secret

You're trying to use a secret as an environment value and it doesn't exists.

{
  "error": {
    "code": "env_secret_missing",
    "message": "Could not find a secret by uid "UID"",
    "uid": UID
  }
}

Domain Errors

These error code could happen when using any domains related endpoints.

Domain Forbidden

You don't have access to the domain, this usually mean this domains is owned by another account or team.

The domain is specified in the message and the DOMAIN key.

{
  "error": {
    "code": "forbidden",
    "message": "You don't have access to \"DOMAIN\"",
    "domain": DOMAIN
  }
}

Domain Not Found

The domain name could not be found in our system. Try to add it first.

{
  "error": {
    "code": "not_found",
    "message": "Domain name not found"
  }
}

Missing Domain Name

The domain name wasn't specified in the URL. This means you tried to use an endpoint which require you to define the domain name in the URL but didn't defined it.

{
  "error": {
    "code": "missing_name",
    "message": "The URL was expected to include the domain name. Example: /domains/google.com"
  }
}

Conflicting Certificates

You must remove the certificates described in the error before removing the domains.

The certificates are specified in the CERT_CNS key.

{
  "error": {
    "code": "conflict_certs",
    "message": "The following certificates must be removed before removing the domain: CERT_CNS",
    "certCNs": CERT_CNS
  }
}

Conflicting Aliases

You must remove the aliases described in the error before removing the domains.

The aliases are specified in the ALIASES key.

{
  "error": {
    "code": "conflict_aliases",
    "message": "The following aliases must be removed before removing the domain: ALIASES",
    "aliases": ALIASES
  }
}

Not Modified

When trying to modify a domain nothing was required to change.

{
  "error": {
    "code": "not_modified",
    "message": "Nothing to do"
  }
}

Missing Name for Domain

When trying to add a domain the name wasn't present in the request body.

{
  "error": {
    "code": "missing_name",
    "message": "The `name` field in the body was expected but is not present in the body payload. Example value: `example.com`"
  }
}

Invalid Name for Domain

The domain name defined in the request body is invalid.

The name is specified in the error as the NAME key.

{
  "error": {
    "code": "invalid_name",
    "message": "The `name` field contains an invalid domain name ("NAME")",
    "name": NAME
  }
}

Custom Domain Needs a Plan Upgrade

In order to add a custom domain to your account or team you need to upgrade to a paid plan.

{
  "error": {
    "code": "custom_domain_needs_upgrade",
    "message": "Domain name creation requires a premium account."
  }
}

Domain Already Exists

The domain name you're trying to add already exists.

The domain name and its current ID are received in the NAME and DOMAIN_ID keys.

{
  "error": {
    "code": "not_modified",
    "message": "The domain "NAME" already exists",
    "name": NAME,
    "uid": DOMAIN_ID
  }
}

Can't Create the Domain

The domain name can't be created. Most probably it couldn't be verified.

{
  "error": {
    "code": "forbidden",
    "message": "You don't have permission to create a domain"
  }
}

Failed to Add Domain after Purchase

We were able to purchase a domain for you but we had an error when trying to add it to your account. Please contact us on vercel.com/support or via support@vercel.com.

{
  "error": {
    "code": "failed_to_add_domain",
    "message": "The domain was bought but couldn't be added.
  }
}

Unable to Determine the Domain Price

We're unable to determine the domain price of a domain.

{
  "error": {
    "code": "service_unavailable",
    "message": "Failed to determine the domain price"
  }
}

Domain price mismatch

The expectedPrice supplied in the request body does not match the actual domain price, which is specified in the actualPrice key.

{
  "error": {
    "code": "price_mismatch",
    "message": "The expected price does not match the actual price",
    "price": ACTUAL_PRICE
  }
}

Domain Is Not Available

The domain name is not available to be purchased.

{
  "error": {
    "code": "not_available",
    "message": "Domain is not available"
  }
}

Invalid Domain Name

The domain name or TLD is invalid or not supported.

{
  "error": {
    "code": "invalid_domain",
    "message": "Invalid domain or TLD"
  }
}

Missing DNS Record Name

The DNS record key name is required and was not provided. It could be any valid DNS record.

{
  "error": {
    "code": "missing_type",
    "message": "Missing `type` parameter"
  }
}

DNS Errors

These error code could happen when using any DNS related endpoint.

Missing DNS Record Name

The DNS record key name is required and was not provided. It should be either a subdomain or @ for the domain itself.

{
  "error": {
    "code": "missing_name",
    "message": "Missing `name` parameter"
  }
}

Missing DNS Record Type

The DNS record key name is required and was not provided. It could be any valid DNS record.

{
  "error": {
    "code": "missing_type",
    "message": "Missing `type` parameter"
  }
}

OAuth2 Errors

These errors could occur when using any OAuth2 related endpoint.

Client Not Found

The OAuth2 client ID could not be found or doesn't exist.

{
  "error": {
    "code": "not_found",
    "message": "OAuth client doesn't not found: CLIENT_ID"
  }
}

/** Enum containing the actions that can be performed against a resource. Group operations are included. */
    ACLAction:
      | "*"
      | "create"
      | "delete"
      | "read"
      | "update"
      | "write"
      | "list"
      | "count";

/** Authentication token metadata. */
interface AuthToken {
  /** The unique identifier of the token. */
  id: string
  /** The human-readable name of the token. */
  name: string
  /** The type of the token. */
  type: string
  /** The origin of how the token was created. */
  origin?: string
  /** The access scopes granted to the token. */
  scopes?: (
    | {
        type: "user"
        origin: "saml" | "github" | "gitlab" | "bitbucket" | "email" | "manual"
        createdAt: number
        expiresAt?: number
      }
    | {
        type: "team"
        teamId: string
        origin: "saml" | "github" | "gitlab" | "bitbucket" | "email" | "manual"
        createdAt: number
        expiresAt?: number
      }
  )[]
  /** Timestamp (in milliseconds) of when the token expires. */
  expiresAt?: number
  /** Timestamp (in milliseconds) of when the token was most recently used. */
  activeAt: number
  /** Timestamp (in milliseconds) of when the token was created. */
  createdAt: number
}

/** Data for the currently authenticated User. */
interface AuthUser {
  /** UNIX timestamp (in milliseconds) when the User account was created. */
  createdAt: number
  /** When the User account has been "soft blocked", this property will contain the date when the restriction was enacted, and the identifier for why. */
  softBlock: {
    blockedAt: number
    reason:
      | "FAIR_USE_LIMITS_EXCEEDED"
      | "ENTERPRISE_TRIAL_ENDED"
      | "BLOCKED_FOR_PLATFORM_ABUSE"
      | "UNPAID_INVOICE"
      | "SUBSCRIPTION_EXPIRED"
      | "SUBSCRIPTION_CANCELED"
  } | null
  /** An object containing billing infomation associated with the User account. */
  billing: {
    currency?: "usd" | "eur"
    addons?: ("custom-deployment-suffix" | "live-support")[] | null
    cancelation?: number | null
    period: {
      start: number
      end: number
    } | null
    contract?: {
      start: number
      end: number
    } | null
    plan:
      | "free"
      | "hobby"
      | "premium"
      | "legacy_pro"
      | "on-demand"
      | "unlimited"
      | "old-pro"
      | "business"
      | "enterprise"
      | "pro"
    platform?: "stripe" | "stripeTestMode"
    programType?: "startup" | "agency"
    trial?: {
      start: number
      end: number
    } | null
    email?: string | null
    tax?: {
      type: string
      id: string
    } | null
    language?: string | null
    address?: {
      line1: string
      line2?: string
      postalCode?: string
      city?: string
      country?: string
      state?: string
    } | null
    name?: string | null
    overdue?: boolean | null
    invoiceItems?: {
      /** Will be used to create an invoice item. The price must be in cents: 2000 for $20. */
      pro?: {
        price: number
        quantity: number
        name?: string
        hidden: boolean
        createdAt?: number
        frequency?: {
          interval: "month"
          intervalCount: 1 | 3 | 2 | 6 | 12
        }
      }
      /** Will be used to create an invoice item. The price must be in cents: 2000 for $20. */
      enterprise?: {
        price: number
        quantity: number
        name?: string
        hidden: boolean
        createdAt?: number
        frequency?: {
          interval: "month"
          intervalCount: 1 | 3 | 2 | 6 | 12
        }
      }
      /** Will be used to create an invoice item. The price must be in cents: 2000 for $20. */
      concurrentBuilds?: {
        price: number
        quantity: number
        name?: string
        hidden: boolean
        createdAt?: number
        frequency?: {
          interval: "month"
          intervalCount: 1 | 3 | 2 | 6 | 12
        }
      }
      /** Will be used to create an invoice item. The price must be in cents: 2000 for $20. */
      saml?: {
        price: number
        quantity: number
        name?: string
        hidden: boolean
        createdAt?: number
        frequency?: {
          interval: "month"
          intervalCount: 1 | 3 | 2 | 6 | 12
        }
      }
      /** Will be used to create an invoice item. The price must be in cents: 2000 for $20. */
      teamSeats?: {
        price: number
        quantity: number
        name?: string
        hidden: boolean
        createdAt?: number
        frequency?: {
          interval: "month"
          intervalCount: 1 | 3 | 2 | 6 | 12
        }
      }
      /** Will be used to create an invoice item. The price must be in cents: 2000 for $20. */
      customCerts?: {
        price: number
        quantity: number
        name?: string
        hidden: boolean
        createdAt?: number
        frequency?: {
          interval: "month"
          intervalCount: 1 | 3 | 2 | 6 | 12
        }
      }
      /** Will be used to create an invoice item. The price must be in cents: 2000 for $20. */
      previewDeploymentSuffix?: {
        price: number
        quantity: number
        name?: string
        hidden: boolean
        createdAt?: number
        frequency?: {
          interval: "month"
          intervalCount: 1 | 3 | 2 | 6 | 12
        }
      }
      /** Will be used to create an invoice item. The price must be in cents: 2000 for $20. */
      passwordProtection?: {
        price: number
        quantity: number
        name?: string
        hidden: boolean
        createdAt?: number
        frequency?: {
          interval: "month"
          intervalCount: 1 | 3 | 2 | 6 | 12
        }
      }
      /** Will be used to create an invoice item. The price must be in cents: 2000 for $20. */
      ssoProtection?: {
        price: number
        quantity: number
        name?: string
        hidden: boolean
        createdAt?: number
        frequency?: {
          interval: "month"
          intervalCount: 1 | 3 | 2 | 6 | 12
        }
      }
      /** Will be used to create an invoice item. The price must be in cents: 2000 for $20. */
      analytics?: {
        price: number
        quantity: number
        name?: string
        hidden: boolean
        createdAt?: number
        frequency?: {
          interval: "month"
          intervalCount: 1 | 3 | 2 | 6 | 12
        }
      }
      analyticsUsage?: {
        price: number
        batch: number
        threshold: number
        name?: string
        hidden: boolean
      }
      bandwidth?: {
        price: number
        batch: number
        threshold: number
        name?: string
        hidden: boolean
      }
      builds?: {
        price: number
        batch: number
        threshold: number
        name?: string
        hidden: boolean
      }
      serverlessFunctionExecution?: {
        price: number
        batch: number
        threshold: number
        name?: string
        hidden: boolean
      }
      sourceImages?: {
        price: number
        batch: number
        threshold: number
        name?: string
        hidden: boolean
      }
      artifacts?: {
        price: number
        batch: number
        threshold: number
        name?: string
        hidden: boolean
      }
    } | null
    invoiceSettings?: {
      footer?: string
    }
    subscriptions?:
      | {
          id: string
          trial: {
            start: number
            end: number
          } | null
          period: {
            start: number
            end: number
          }
          frequency: {
            interval: "month" | "day" | "week" | "year"
            intervalCount: number
          }
          discount: {
            id: string
            coupon: {
              id: string
              name: string | null
              amountOff: number | null
              percentageOff: number | null
              durationInMonths: number | null
              duration: "forever" | "repeating" | "once"
            }
          } | null
          items: {
            id: string
            priceId: string
            productId: string
            amount: number
            quantity: number
          }[]
        }[]
      | null
    controls?: {
      analyticsSampleRateInPercent?: number | null
      analyticsSpendLimitInDollars?: number | null
    } | null
    purchaseOrder?: string | null
    status?: "active" | "trialing" | "overdue" | "expired" | "canceled"
  } | null
  /** An object containing infomation related to the amount of platform resources may be allocated to the User account. */
  resourceConfig: {
    nodeType?: string
    concurrentBuilds?: number
    awsAccountType?: string
    awsAccountIds?: string[]
    cfZoneName?: string
  }
  /** Prefix that will be used in the URL of "Preview" deployments created by the User account. */
  stagingPrefix: string
  importFlowGitNamespace?: (string | number) | null
  importFlowGitNamespaceId?: (string | number) | null
  importFlowGitProvider?: "github" | "gitlab" | "bitbucket"
  preferredScopesAndGitNamespaces?: {
    scopeId: string
    gitNamespaceId: (string | number) | null
  }[]
  /** Whether the user has a trial available for a paid plan subscription. */
  hasTrialAvailable: boolean
  /** remote caching settings */
  remoteCaching?: {
    enabled?: boolean
  }
  /** The User's unique identifier. */
  id: string
  /** Email address associated with the User account. */
  email: string
  /** Name associated with the User account, or `null` if none has been provided. */
  name: string | null
  /** Unique username associated with the User account. */
  username: string
  /** SHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image. */
  avatar: string | null
}

/** A limited form of data for the currently authenticated User, due to the authentication token missing privileges to read the full User data. */
interface AuthUserLimited {
  /** Property indicating that this User data contains only limited information, due to the authentication token missing privileges to read the full User data. Re-login with email, GitHub, GitLab or Bitbucket in order to upgrade the authentication token with the necessary privileges. */
  limited: boolean
  /** The User's unique identifier. */
  id: string
  /** Email address associated with the User account. */
  email: string
  /** Name associated with the User account, or `null` if none has been provided. */
  name: string | null
  /** Unique username associated with the User account. */
  username: string
  /** SHA1 hash of the avatar for the User account. Can be used in conjuction with the ... endpoint to retrieve the avatar image. */
  avatar: string | null
}

interface DeploymentCreatedEvent {
  type: "deployment"
  payload: {
    alias?: string[]
    deployment: {
      id: string
      meta?: { [key: string]: string }
      name: string
      url: string
      inspectorUrl: string
    }
    links: {
      deployment: string
      project: string
    }
    deploymentId: string
    name: string
    plan: string
    project: string
    target?: ("staging" | "production") | null
    projectId: string
    regions: string[]
    type: "LAMBDAS"
    url: string
  }
  clientId: string
  createdAt: number
  id: string
  ownerId: string
  region?: string | null
  teamId?: string | null
  userId: string
  webhookId: string
}

interface DeploymentErrorEvent {
  type: "deployment-error"
  payload: {
    deployment: {
      id: string
      meta?: { [key: string]: string }
      name: string
      url: string
      inspectorUrl: string
    }
    links: {
      deployment: string
      project: string
    }
    deploymentId: string
    name: string
    plan: string
    project: string
    projectId: string
    regions: string[]
    target?: ("staging" | "production") | null
    type: "LAMBDAS"
    url: string
  }
  clientId: string
  createdAt: number
  id: string
  ownerId: string
  region?: string | null
  teamId?: string | null
  userId: string
  webhookId: string
}

interface DeploymentPreparedEvent {
  type: "deployment-prepared"
  payload: {
    deployment: {
      id: string
      meta?: { [key: string]: string }
      name: string
      url: string
      inspectorUrl: string
    }
    links: {
      deployment: string
      project: string
    }
    deploymentId: string
    name: string
    plan: string
    project: string
    projectId: string
    regions: string[]
    target?: ("staging" | "production") | null
    type: "LAMBDAS"
    url: string
  }
  clientId: string
  createdAt: number
  id: string
  ownerId: string
  region?: string | null
  teamId?: string | null
  userId: string
  webhookId: string
}

interface DeploymentReadyEvent {
  type: "deployment-ready"
  payload: {
    deployment: {
      id: string
      meta?: { [key: string]: string }
      name: string
      url: string
      inspectorUrl: string
    }
    links: {
      deployment: string
      project: string
    }
    deploymentId: string
    name: string
    plan: string
    project: string
    projectId: string
    regions: string[]
    target?: ("staging" | "production") | null
    type: "LAMBDAS"
    url: string
  }
  clientId: string
  createdAt: number
  id: string
  ownerId: string
  region?: string | null
  teamId?: string | null
  userId: string
  webhookId: string
}

interface DomainCreatedEvent {
  type: "domain-created"
  payload: {
    domain: {
      name: string
      delegated: boolean
    }
  }
  clientId: string
  createdAt: number
  id: string
  ownerId: string
  region?: string | null
  teamId?: string | null
  userId: string
  webhookId: string
}

/** A deployment file tree entry */
interface FileTree {
  /** The name of the file tree entry */
  name: string
  /** String indicating the type of file tree entry. */
  type: "directory" | "file" | "symlink" | "lambda" | "middleware" | "invalid"
  /** The unique identifier of the file (only valid for the `file` type) */
  uid?: string
  /** The list of children files of the directory (only valid for the `directory` type) */
  children?: FileTree[]
  /** The content-type of the file (only valid for the `file` type) */
  contentType?: string
  /** The file "mode" indicating file type and permissions. */
  mode: number
  /** Not currently used. See `file-list-to-tree.ts`. */
  symlink?: string
}

interface IntegrationConfigurationPermissionUpdatedEvent {
  type: "integration-configuration-permission-updated"
  payload: {
    configuration: {
      id: string
      projectSelection: "selected" | "all"
      projects: string[]
    }
    projects: {
      added: string[]
      removed: string[]
    }
  }
  clientId: string
  createdAt: number
  id: string
  ownerId: string
  region?: string | null
  teamId?: string | null
  userId: string
  webhookId: string
}

interface IntegrationConfigurationRemovedEvent {
  type: "integration-configuration-removed"
  payload: {
    configuration: {
      id: string
      projectSelection: "selected" | "all"
      projects: string[]
    }
  }
  clientId: string
  createdAt: number
  id: string
  ownerId: string
  region?: string | null
  teamId?: string | null
  userId: string
  webhookId: string
}

/** This object contains information related to the pagination of the current request, including the necessary parameters to get the next or previous page of data. */
interface Pagination {
  /** Amount of items in the current page. */
  count: number
  /** Timestamp that must be used to request the next page. */
  next: number | null
  /** Timestamp that must be used to request the previous page. */
  prev: number | null
}

/** Data representing a Team. */
interface Team {
  [key: string]: unknown
}