Skip to content

Commit 54025ee

Browse files
waleedlatif1waleedlatif1
committed
feat(vercel): add webhook and deployment check tools
Add 8 new Vercel API tools: - Webhooks: list, create, delete - Deployment Checks: create, get, list, update, rerequest Brings total Vercel tools to 50.
1 parent 6e62d96 commit 54025ee

File tree

13 files changed

+1477
-7
lines changed

13 files changed

+1477
-7
lines changed

‎apps/docs/content/docs/en/tools/vercel.mdx‎

Lines changed: 241 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@ import { BlockInfoCard } from "@/components/ui/block-info-card"
1111
/>
1212

1313
{/* MANUAL-CONTENT-START:intro */}
14-
[Vercel](https://vercel.com/) is a platform for developing, previewing, and shipping modern frontend applications, APIs, and Jamstack sites with ease. A Jamstack site is a web application built using JavaScript, APIs, and Markup—designed to serve pre-rendered static files, leverage dynamic backend services via APIs, and provide fast, secure, and scalable user experiences.
14+
[Vercel](https://vercel.com/) describes itself as **the AI Cloud**: a platform that provides developer tools and cloud infrastructure to build, scale, and secure faster, more personalized web experiences. It is widely used to build and ship modern web apps and agentic workloads, with built-in support for Git-based workflows, preview deployments, and production delivery.
1515

1616
With Vercel, you can:
1717

18-
- **Automate deployments**: Instantly deploy static sites and serverless functions for your front-end projects with zero configuration
19-
- **Manage projects and teams**: Organize deployments, domains, environment variables, and more across multiple projects and teams
20-
- **Control environments and domains**: Manage production, preview, and development environments and seamlessly handle custom domains and DNS settings
21-
- **Monitor and debug**: Observe deployment status, review build logs, and inspect environment settings and configuration in real time
18+
- **Automate deployments**: Deploy from Git and manage preview and production releases with minimal operational overhead
19+
- **Manage projects and teams**: Organize projects, team access, and settings across multiple environments
20+
- **Control infrastructure settings**: Configure domains, DNS, aliases, environment variables, and edge settings in one place
21+
- **Monitor and troubleshoot**: Track deployment status, inspect logs, and debug build or runtime issues
2222

23-
In Sim, the Vercel integration enables your agents to programmatically manage deployments, projects, domains, DNS records, aliases, environment variables, edge configs, and teams directly from your workflows. Agents can automate the deployment process, access environment data, monitor build statuses, and perform infrastructure changes in response to triggers or as part of intelligent workflow automation. Combine Vercel's infrastructure automation with Sim's workflow capabilities to create modern, fully automated DevOps and product development pipelines.
23+
In Sim, the Vercel integration lets your agents programmatically manage deployments, projects, domains, DNS records, aliases, environment variables, edge configs, and teams directly from workflows. You can automate deployment operations, react to status changes, and run infrastructure tasks as part of reliable, end-to-end delivery workflows.
2424
{/* MANUAL-CONTENT-END */}
2525

2626

@@ -1006,6 +1006,241 @@ Create, update, upsert, or delete items in an Edge Config store
10061006
| --------- | ---- | ----------- |
10071007
| `status` | string | Operation status |
10081008

1009+
### `vercel_list_webhooks`
1010+
1011+
List webhooks for a Vercel project or team
1012+
1013+
#### Input
1014+
1015+
| Parameter | Type | Required | Description |
1016+
| --------- | ---- | -------- | ----------- |
1017+
| `apiKey` | string | Yes | Vercel Access Token |
1018+
| `projectId` | string | No | Filter webhooks by project ID |
1019+
| `teamId` | string | No | Team ID to scope the request |
1020+
1021+
#### Output
1022+
1023+
| Parameter | Type | Description |
1024+
| --------- | ---- | ----------- |
1025+
| `webhooks` | array | List of webhooks |
1026+
| ↳ `id` | string | Webhook ID |
1027+
| ↳ `url` | string | Webhook URL |
1028+
| ↳ `events` | array | Events the webhook listens to |
1029+
| ↳ `ownerId` | string | Owner ID |
1030+
| ↳ `projectIds` | array | Associated project IDs |
1031+
| ↳ `createdAt` | number | Creation timestamp |
1032+
| ↳ `updatedAt` | number | Last updated timestamp |
1033+
| `count` | number | Number of webhooks returned |
1034+
1035+
### `vercel_create_webhook`
1036+
1037+
Create a new webhook for a Vercel team
1038+
1039+
#### Input
1040+
1041+
| Parameter | Type | Required | Description |
1042+
| --------- | ---- | -------- | ----------- |
1043+
| `apiKey` | string | Yes | Vercel Access Token |
1044+
| `url` | string | Yes | Webhook URL \(must be https\) |
1045+
| `events` | string | Yes | Comma-separated event names to subscribe to |
1046+
| `projectIds` | string | No | Comma-separated project IDs to scope the webhook to |
1047+
| `teamId` | string | Yes | Team ID to create the webhook for |
1048+
1049+
#### Output
1050+
1051+
| Parameter | Type | Description |
1052+
| --------- | ---- | ----------- |
1053+
| `id` | string | Webhook ID |
1054+
| `url` | string | Webhook URL |
1055+
| `secret` | string | Webhook signing secret |
1056+
| `events` | array | Events the webhook listens to |
1057+
| `ownerId` | string | Owner ID |
1058+
| `projectIds` | array | Associated project IDs |
1059+
| `createdAt` | number | Creation timestamp |
1060+
| `updatedAt` | number | Last updated timestamp |
1061+
1062+
### `vercel_delete_webhook`
1063+
1064+
Delete a webhook from a Vercel team
1065+
1066+
#### Input
1067+
1068+
| Parameter | Type | Required | Description |
1069+
| --------- | ---- | -------- | ----------- |
1070+
| `apiKey` | string | Yes | Vercel Access Token |
1071+
| `webhookId` | string | Yes | The webhook ID to delete |
1072+
| `teamId` | string | No | Team ID to scope the request |
1073+
1074+
#### Output
1075+
1076+
| Parameter | Type | Description |
1077+
| --------- | ---- | ----------- |
1078+
| `deleted` | boolean | Whether the webhook was successfully deleted |
1079+
1080+
### `vercel_create_check`
1081+
1082+
Create a new deployment check
1083+
1084+
#### Input
1085+
1086+
| Parameter | Type | Required | Description |
1087+
| --------- | ---- | -------- | ----------- |
1088+
| `apiKey` | string | Yes | Vercel Access Token |
1089+
| `deploymentId` | string | Yes | Deployment ID to create the check for |
1090+
| `name` | string | Yes | Name of the check \(max 100 characters\) |
1091+
| `blocking` | boolean | Yes | Whether the check blocks the deployment |
1092+
| `path` | string | No | Page path being checked |
1093+
| `detailsUrl` | string | No | URL with details about the check |
1094+
| `externalId` | string | No | External identifier for the check |
1095+
| `rerequestable` | boolean | No | Whether the check can be rerequested |
1096+
| `teamId` | string | No | Team ID to scope the request |
1097+
1098+
#### Output
1099+
1100+
| Parameter | Type | Description |
1101+
| --------- | ---- | ----------- |
1102+
| `id` | string | Check ID |
1103+
| `name` | string | Check name |
1104+
| `status` | string | Check status: registered, running, or completed |
1105+
| `conclusion` | string | Check conclusion: canceled, failed, neutral, succeeded, skipped, or stale |
1106+
| `blocking` | boolean | Whether the check blocks the deployment |
1107+
| `deploymentId` | string | Associated deployment ID |
1108+
| `integrationId` | string | Associated integration ID |
1109+
| `externalId` | string | External identifier |
1110+
| `detailsUrl` | string | URL with details about the check |
1111+
| `path` | string | Page path being checked |
1112+
| `rerequestable` | boolean | Whether the check can be rerequested |
1113+
| `createdAt` | number | Creation timestamp in milliseconds |
1114+
| `updatedAt` | number | Last update timestamp in milliseconds |
1115+
| `startedAt` | number | Start timestamp in milliseconds |
1116+
| `completedAt` | number | Completion timestamp in milliseconds |
1117+
1118+
### `vercel_get_check`
1119+
1120+
Get details of a specific deployment check
1121+
1122+
#### Input
1123+
1124+
| Parameter | Type | Required | Description |
1125+
| --------- | ---- | -------- | ----------- |
1126+
| `apiKey` | string | Yes | Vercel Access Token |
1127+
| `deploymentId` | string | Yes | Deployment ID the check belongs to |
1128+
| `checkId` | string | Yes | Check ID to retrieve |
1129+
| `teamId` | string | No | Team ID to scope the request |
1130+
1131+
#### Output
1132+
1133+
| Parameter | Type | Description |
1134+
| --------- | ---- | ----------- |
1135+
| `id` | string | Check ID |
1136+
| `name` | string | Check name |
1137+
| `status` | string | Check status: registered, running, or completed |
1138+
| `conclusion` | string | Check conclusion: canceled, failed, neutral, succeeded, skipped, or stale |
1139+
| `blocking` | boolean | Whether the check blocks the deployment |
1140+
| `deploymentId` | string | Associated deployment ID |
1141+
| `integrationId` | string | Associated integration ID |
1142+
| `externalId` | string | External identifier |
1143+
| `detailsUrl` | string | URL with details about the check |
1144+
| `path` | string | Page path being checked |
1145+
| `rerequestable` | boolean | Whether the check can be rerequested |
1146+
| `createdAt` | number | Creation timestamp in milliseconds |
1147+
| `updatedAt` | number | Last update timestamp in milliseconds |
1148+
| `startedAt` | number | Start timestamp in milliseconds |
1149+
| `completedAt` | number | Completion timestamp in milliseconds |
1150+
1151+
### `vercel_list_checks`
1152+
1153+
List all checks for a deployment
1154+
1155+
#### Input
1156+
1157+
| Parameter | Type | Required | Description |
1158+
| --------- | ---- | -------- | ----------- |
1159+
| `apiKey` | string | Yes | Vercel Access Token |
1160+
| `deploymentId` | string | Yes | Deployment ID to list checks for |
1161+
| `teamId` | string | No | Team ID to scope the request |
1162+
1163+
#### Output
1164+
1165+
| Parameter | Type | Description |
1166+
| --------- | ---- | ----------- |
1167+
| `checks` | array | List of deployment checks |
1168+
| ↳ `id` | string | Check ID |
1169+
| ↳ `name` | string | Check name |
1170+
| ↳ `status` | string | Check status |
1171+
| ↳ `conclusion` | string | Check conclusion |
1172+
| ↳ `blocking` | boolean | Whether the check blocks the deployment |
1173+
| ↳ `deploymentId` | string | Associated deployment ID |
1174+
| ↳ `integrationId` | string | Associated integration ID |
1175+
| ↳ `externalId` | string | External identifier |
1176+
| ↳ `detailsUrl` | string | URL with details about the check |
1177+
| ↳ `path` | string | Page path being checked |
1178+
| ↳ `rerequestable` | boolean | Whether the check can be rerequested |
1179+
| ↳ `createdAt` | number | Creation timestamp |
1180+
| ↳ `updatedAt` | number | Last update timestamp |
1181+
| ↳ `startedAt` | number | Start timestamp |
1182+
| ↳ `completedAt` | number | Completion timestamp |
1183+
| `count` | number | Total number of checks |
1184+
1185+
### `vercel_update_check`
1186+
1187+
Update an existing deployment check
1188+
1189+
#### Input
1190+
1191+
| Parameter | Type | Required | Description |
1192+
| --------- | ---- | -------- | ----------- |
1193+
| `apiKey` | string | Yes | Vercel Access Token |
1194+
| `deploymentId` | string | Yes | Deployment ID the check belongs to |
1195+
| `checkId` | string | Yes | Check ID to update |
1196+
| `name` | string | No | Updated name of the check |
1197+
| `status` | string | No | Updated status: running or completed |
1198+
| `conclusion` | string | No | Check conclusion: canceled, failed, neutral, succeeded, or skipped |
1199+
| `detailsUrl` | string | No | URL with details about the check |
1200+
| `externalId` | string | No | External identifier for the check |
1201+
| `path` | string | No | Page path being checked |
1202+
| `output` | string | No | JSON string with check output metrics |
1203+
| `teamId` | string | No | Team ID to scope the request |
1204+
1205+
#### Output
1206+
1207+
| Parameter | Type | Description |
1208+
| --------- | ---- | ----------- |
1209+
| `id` | string | Check ID |
1210+
| `name` | string | Check name |
1211+
| `status` | string | Check status: registered, running, or completed |
1212+
| `conclusion` | string | Check conclusion: canceled, failed, neutral, succeeded, skipped, or stale |
1213+
| `blocking` | boolean | Whether the check blocks the deployment |
1214+
| `deploymentId` | string | Associated deployment ID |
1215+
| `integrationId` | string | Associated integration ID |
1216+
| `externalId` | string | External identifier |
1217+
| `detailsUrl` | string | URL with details about the check |
1218+
| `path` | string | Page path being checked |
1219+
| `rerequestable` | boolean | Whether the check can be rerequested |
1220+
| `createdAt` | number | Creation timestamp in milliseconds |
1221+
| `updatedAt` | number | Last update timestamp in milliseconds |
1222+
| `startedAt` | number | Start timestamp in milliseconds |
1223+
| `completedAt` | number | Completion timestamp in milliseconds |
1224+
1225+
### `vercel_rerequest_check`
1226+
1227+
Rerequest a deployment check
1228+
1229+
#### Input
1230+
1231+
| Parameter | Type | Required | Description |
1232+
| --------- | ---- | -------- | ----------- |
1233+
| `apiKey` | string | Yes | Vercel Access Token |
1234+
| `deploymentId` | string | Yes | Deployment ID the check belongs to |
1235+
| `checkId` | string | Yes | Check ID to rerequest |
1236+
| `teamId` | string | No | Team ID to scope the request |
1237+
1238+
#### Output
1239+
1240+
| Parameter | Type | Description |
1241+
| --------- | ---- | ----------- |
1242+
| `rerequested` | boolean | Whether the check was successfully rerequested |
1243+
10091244
### `vercel_list_teams`
10101245

10111246
List all teams in a Vercel account

0 commit comments

Comments
 (0)