Help
Log InSign Up
v0.0.1
OAS 3.0.3

Vercel REST API

The Vercel REST API is a REST-styled API that gives you full control over the entire Vercel platform. You can use it with any programming language or framework that can send HTTP requests. You need to authenticate with a Vercel access token for every request.

Production API

No authentication selected
Client Libraries
Fetch JavaScript

access-groups​

access-groups Endpoints

aliases​

aliases Endpoints

artifacts​

artifacts Endpoints

authentication​

authentication Endpoints

certs​

certs Endpoints

checks​

checks Endpoints

deployments​

deployments Endpoints

dns​

dns Endpoints

domains​

domains Endpoints

edge-config​

edge-config Endpoints

environment​

environment Endpoints

integrations​

integrations Endpoints

logDrains​

logDrains Endpoints

marketplace​

marketplace Endpoints

projectMembers​

projectMembers Endpoints

projects​

projects Endpoints

secrets​

secrets Endpoints

security​

security Endpoints

teams​

teams Endpoints

user​

user Endpoints

webhooks​

webhooks Endpoints

Creates a webhook​

Creates a webhook

Query Parameters
  • teamId
    string

    The Team identifier to perform the request on behalf of.

  • slug
    string

    The Team slug to perform the request on behalf of.

Body
application/json
url
string uri^https?://
required
events
array string[] 1…enum
required
  • budget.reached
  • budget.reset
  • domain.created
  • deployment.created
  • deployment.error
projectIds
array string[] 1…50
Responses
  • 400

    One of the provided values in the request body is invalid.

  • 401
  • 403

    You do not have permission to access this resource.

POST/v1/webhooks
fetch('https://api.vercel.com/v1/webhooks', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    url: '',
    events: ['budget.reached'],
    projectIds: ['']
  })
})

{
  "secret": "…",
  "events": "deployment.created",
  "id": "account_hook_GflD6EYyo7F4ViYS",
  "url": "https://my-webhook.com",
  "ownerId": "ZspSRT4ljIEEmMHgoDwKWDei",
  "createdAt": 1567024758130,
  "updatedAt": 1567024758130,
  "projectIds": [
    "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB"
  ]
}

Deletes a webhook​

Deletes a webhook

Path Parameters
  • id
    string
    required
Query Parameters
  • teamId
    string

    The Team identifier to perform the request on behalf of.

  • slug
    string

    The Team slug to perform the request on behalf of.

Responses
  • 204
  • 400

    One of the provided values in the request query is invalid.

  • 401
  • 403

    You do not have permission to access this resource.

DELETE/v1/webhooks/{id}
fetch('https://api.vercel.com/v1/webhooks/{id}', {
  method: 'DELETE'
})
No Body

Get a list of webhooks​

Get a list of webhooks

Query Parameters
  • projectId
    string ^[a-zA-z0-9_]+$
  • teamId
    string

    The Team identifier to perform the request on behalf of.

  • slug
    string

    The Team slug to perform the request on behalf of.

Responses
  • 400

    One of the provided values in the request query is invalid.

  • 401
  • 403

    You do not have permission to access this resource.

GET/v1/webhooks
fetch('https://api.vercel.com/v1/webhooks')

[
  {
    "projectsMetadata": [
      {
        "id": "…",
        "name": "…",
        "framework": "blitzjs",
        "latestDeployment": "…"
      }
    ],
    "events": "deployment.created",
    "id": "account_hook_GflD6EYyo7F4ViYS",
    "url": "https://my-webhook.com",
    "ownerId": "ZspSRT4ljIEEmMHgoDwKWDei",
    "createdAt": 1567024758130,
    "updatedAt": 1567024758130,
    "projectIds": [
      "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB"
    ]
  }
]

Get a webhook​

Get a webhook

Path Parameters
  • id
    string
    required
Query Parameters
  • teamId
    string

    The Team identifier to perform the request on behalf of.

  • slug
    string

    The Team slug to perform the request on behalf of.

Responses
  • 400

    One of the provided values in the request query is invalid.

  • 401
  • 403

    You do not have permission to access this resource.

GET/v1/webhooks/{id}
fetch('https://api.vercel.com/v1/webhooks/{id}')

{
  "events": "deployment.created",
  "id": "account_hook_GflD6EYyo7F4ViYS",
  "url": "https://my-webhook.com",
  "ownerId": "ZspSRT4ljIEEmMHgoDwKWDei",
  "createdAt": 1567024758130,
  "updatedAt": 1567024758130,
  "projectIds": [
    "prj_12HKQaOmR5t5Uy6vdcQsNIiZgHGB"
  ]
}

Models