Available Vercel triggers for automating workflows
Vercel provides 8 triggers for automating workflows based on events.
Trigger workflow when a deployment is canceled
| Parameter | Type | Required | Description |
|---|
apiKey | api-key-picker | Yes | Vercel connection used to create and manage the webhook. |
teamId | string | No | Scope webhook to a specific team |
filterProjectIds | string | No | Limit webhook to specific projects |
| Parameter | Type | Description |
|---|
type | string | Event type (e.g., deployment.created) |
id | string | Unique webhook delivery ID (string) |
createdAt | number | Event timestamp in milliseconds |
region | string | Region where the event occurred |
payload | json | Raw event payload from Vercel |
links | object | links output from the tool |
↳ deployment | string | Vercel Dashboard URL for the deployment |
↳ project | string | Vercel Dashboard URL for the project |
regions | json | Regions associated with the deployment (array), when provided by Vercel |
deployment | object | deployment output from the tool |
↳ id | string | Deployment ID |
↳ url | string | Deployment URL |
↳ name | string | Deployment name |
↳ meta | json | Deployment metadata map (e.g. Git metadata), per Vercel Webhooks API |
project | object | project output from the tool |
↳ id | string | Project ID |
↳ name | string | Project name |
team | object | team output from the tool |
↳ id | string | Team ID |
user | object | user output from the tool |
↳ id | string | User ID |
target | string | Deployment target (production, staging, or preview) |
plan | string | Account plan type |
domain | object | domain output from the tool |
↳ name | string | Domain name |
↳ delegated | boolean | Whether the domain was delegated/shared when present on the payload |
Trigger workflow when a new deployment is created
| Parameter | Type | Required | Description |
|---|
apiKey | api-key-picker | Yes | Vercel connection used to create and manage the webhook. |
teamId | string | No | Scope webhook to a specific team |
filterProjectIds | string | No | Limit webhook to specific projects |
| Parameter | Type | Description |
|---|
type | string | Event type (e.g., deployment.created) |
id | string | Unique webhook delivery ID (string) |
createdAt | number | Event timestamp in milliseconds |
region | string | Region where the event occurred |
payload | json | Raw event payload from Vercel |
links | object | links output from the tool |
↳ deployment | string | Vercel Dashboard URL for the deployment |
↳ project | string | Vercel Dashboard URL for the project |
regions | json | Regions associated with the deployment (array), when provided by Vercel |
deployment | object | deployment output from the tool |
↳ id | string | Deployment ID |
↳ url | string | Deployment URL |
↳ name | string | Deployment name |
↳ meta | json | Deployment metadata map (e.g. Git metadata), per Vercel Webhooks API |
project | object | project output from the tool |
↳ id | string | Project ID |
↳ name | string | Project name |
team | object | team output from the tool |
↳ id | string | Team ID |
user | object | user output from the tool |
↳ id | string | User ID |
target | string | Deployment target (production, staging, or preview) |
plan | string | Account plan type |
domain | object | domain output from the tool |
↳ name | string | Domain name |
↳ delegated | boolean | Whether the domain was delegated/shared when present on the payload |
Trigger workflow when a deployment fails
| Parameter | Type | Required | Description |
|---|
apiKey | api-key-picker | Yes | Vercel connection used to create and manage the webhook. |
teamId | string | No | Scope webhook to a specific team |
filterProjectIds | string | No | Limit webhook to specific projects |
| Parameter | Type | Description |
|---|
type | string | Event type (e.g., deployment.created) |
id | string | Unique webhook delivery ID (string) |
createdAt | number | Event timestamp in milliseconds |
region | string | Region where the event occurred |
payload | json | Raw event payload from Vercel |
links | object | links output from the tool |
↳ deployment | string | Vercel Dashboard URL for the deployment |
↳ project | string | Vercel Dashboard URL for the project |
regions | json | Regions associated with the deployment (array), when provided by Vercel |
deployment | object | deployment output from the tool |
↳ id | string | Deployment ID |
↳ url | string | Deployment URL |
↳ name | string | Deployment name |
↳ meta | json | Deployment metadata map (e.g. Git metadata), per Vercel Webhooks API |
project | object | project output from the tool |
↳ id | string | Project ID |
↳ name | string | Project name |
team | object | team output from the tool |
↳ id | string | Team ID |
user | object | user output from the tool |
↳ id | string | User ID |
target | string | Deployment target (production, staging, or preview) |
plan | string | Account plan type |
domain | object | domain output from the tool |
↳ name | string | Domain name |
↳ delegated | boolean | Whether the domain was delegated/shared when present on the payload |
Trigger workflow when a deployment is ready to serve traffic
| Parameter | Type | Required | Description |
|---|
apiKey | api-key-picker | Yes | Vercel connection used to create and manage the webhook. |
teamId | string | No | Scope webhook to a specific team |
filterProjectIds | string | No | Limit webhook to specific projects |
| Parameter | Type | Description |
|---|
type | string | Event type (e.g., deployment.created) |
id | string | Unique webhook delivery ID (string) |
createdAt | number | Event timestamp in milliseconds |
region | string | Region where the event occurred |
payload | json | Raw event payload from Vercel |
links | object | links output from the tool |
↳ deployment | string | Vercel Dashboard URL for the deployment |
↳ project | string | Vercel Dashboard URL for the project |
regions | json | Regions associated with the deployment (array), when provided by Vercel |
deployment | object | deployment output from the tool |
↳ id | string | Deployment ID |
↳ url | string | Deployment URL |
↳ name | string | Deployment name |
↳ meta | json | Deployment metadata map (e.g. Git metadata), per Vercel Webhooks API |
project | object | project output from the tool |
↳ id | string | Project ID |
↳ name | string | Project name |
team | object | team output from the tool |
↳ id | string | Team ID |
user | object | user output from the tool |
↳ id | string | User ID |
target | string | Deployment target (production, staging, or preview) |
plan | string | Account plan type |
domain | object | domain output from the tool |
↳ name | string | Domain name |
↳ delegated | boolean | Whether the domain was delegated/shared when present on the payload |
Trigger workflow when a domain is created
| Parameter | Type | Required | Description |
|---|
apiKey | api-key-picker | Yes | Vercel connection used to create and manage the webhook. |
teamId | string | No | Scope webhook to a specific team |
filterProjectIds | string | No | Limit webhook to specific projects |
| Parameter | Type | Description |
|---|
type | string | Event type (e.g., deployment.created) |
id | string | Unique webhook delivery ID (string) |
createdAt | number | Event timestamp in milliseconds |
region | string | Region where the event occurred |
payload | json | Raw event payload from Vercel |
links | object | links output from the tool |
↳ deployment | string | Vercel Dashboard URL for the deployment |
↳ project | string | Vercel Dashboard URL for the project |
regions | json | Regions associated with the deployment (array), when provided by Vercel |
deployment | object | deployment output from the tool |
↳ id | string | Deployment ID |
↳ url | string | Deployment URL |
↳ name | string | Deployment name |
↳ meta | json | Deployment metadata map (e.g. Git metadata), per Vercel Webhooks API |
domain | object | domain output from the tool |
↳ name | string | Domain name |
↳ delegated | boolean | Whether the domain was delegated/shared (domain.created), per Vercel Webhooks API |
project | object | project output from the tool |
↳ id | string | Project ID |
team | object | team output from the tool |
↳ id | string | Team ID |
user | object | user output from the tool |
↳ id | string | User ID |
Trigger workflow when a new project is created
| Parameter | Type | Required | Description |
|---|
apiKey | api-key-picker | Yes | Vercel connection used to create and manage the webhook. |
teamId | string | No | Scope webhook to a specific team |
filterProjectIds | string | No | Limit webhook to specific projects |
| Parameter | Type | Description |
|---|
type | string | Event type (e.g., deployment.created) |
id | string | Unique webhook delivery ID (string) |
createdAt | number | Event timestamp in milliseconds |
region | string | Region where the event occurred |
payload | json | Raw event payload from Vercel |
links | object | links output from the tool |
↳ deployment | string | Vercel Dashboard URL for the deployment |
↳ project | string | Vercel Dashboard URL for the project |
regions | json | Regions associated with the deployment (array), when provided by Vercel |
deployment | object | deployment output from the tool |
↳ id | string | Deployment ID |
↳ url | string | Deployment URL |
↳ name | string | Deployment name |
↳ meta | json | Deployment metadata map (e.g. Git metadata), per Vercel Webhooks API |
project | object | project output from the tool |
↳ id | string | Project ID |
↳ name | string | Project name |
team | object | team output from the tool |
↳ id | string | Team ID |
user | object | user output from the tool |
↳ id | string | User ID |
Trigger workflow when a project is removed
| Parameter | Type | Required | Description |
|---|
apiKey | api-key-picker | Yes | Vercel connection used to create and manage the webhook. |
teamId | string | No | Scope webhook to a specific team |
filterProjectIds | string | No | Limit webhook to specific projects |
| Parameter | Type | Description |
|---|
type | string | Event type (e.g., deployment.created) |
id | string | Unique webhook delivery ID (string) |
createdAt | number | Event timestamp in milliseconds |
region | string | Region where the event occurred |
payload | json | Raw event payload from Vercel |
links | object | links output from the tool |
↳ deployment | string | Vercel Dashboard URL for the deployment |
↳ project | string | Vercel Dashboard URL for the project |
regions | json | Regions associated with the deployment (array), when provided by Vercel |
deployment | object | deployment output from the tool |
↳ id | string | Deployment ID |
↳ url | string | Deployment URL |
↳ name | string | Deployment name |
↳ meta | json | Deployment metadata map (e.g. Git metadata), per Vercel Webhooks API |
project | object | project output from the tool |
↳ id | string | Project ID |
↳ name | string | Project name |
team | object | team output from the tool |
↳ id | string | Team ID |
user | object | user output from the tool |
↳ id | string | User ID |
Trigger on a curated set of common Vercel events (deployments, projects, domains, edge config). Pick a specific trigger to listen to one event type only.
| Parameter | Type | Required | Description |
|---|
apiKey | api-key-picker | Yes | Vercel connection used to create and manage the webhook. |
teamId | string | No | Scope webhook to a specific team |
filterProjectIds | string | No | Limit webhook to specific projects |
| Parameter | Type | Description |
|---|
type | string | Event type (e.g., deployment.created) |
id | string | Unique webhook delivery ID (string) |
createdAt | number | Event timestamp in milliseconds |
region | string | Region where the event occurred |
links | object | links output from the tool |
↳ deployment | string | Vercel Dashboard URL for the deployment |
↳ project | string | Vercel Dashboard URL for the project |
regions | json | Regions associated with the deployment (array), when provided by Vercel |
deployment | object | deployment output from the tool |
↳ id | string | Deployment ID |
↳ url | string | Deployment URL |
↳ name | string | Deployment name |
↳ meta | json | Deployment metadata map (e.g. Git metadata), per Vercel Webhooks API |
payload | json | Full event payload |
