Skip to content
Docs

List Event Types

GEThttps://api.vercel.com/v1/events/types
Returns the list of user-facing event types with descriptions.
https://api.vercel.com/v1/events/types
const response = await fetch('https://api.vercel.com/v1/events/types?teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});


const data = await response.json();
console.log(data);
Response
{
  "types": [
    {
      "name": "deployment-created",
      "description": "string",
      "categories": [],
      "deprecated": "false",
      "replacedBy": []
    }
  ],
  "categories": [
    {
      "name": "account",
      "label": "string"
    }
  ]
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Response

200Success
typesarrayRequired
categoriesarrayRequired

Errors

400Error
401The request is not authorized.
403You do not have permission to access this resource.
410Error