enhancementgood first issueintegrationnew-featurenew-integration
Métriques du dépôt
- Stars
- (1 930 étoiles)
- Métriques de merge PR
- (Métriques PR en attente)
Description
Description
Add Vercel integration to sync deployment data, project configurations, domain management, and environment variables into CORE.
Reference Implementations
Existing Integrations (use as templates)
integrations/github/- Similar developer platform systemintegrations/linear/- Project management integrationintegrations/slack/- For reference
Required Files Structure
integrations/vercel/
├── src/
│ ├── index.ts # Main entry, OAuth spec
│ ├── schedule.ts # Sync logic
│ ├── utils.ts # Vercel API utilities
│ ├── account-create.ts # OAuth setup
│ └── create-activity.ts # Activity formatting
├── package.json
├── tsup.config.ts
└── README.md
Vercel API Integration
OAuth Setup
- Use Vercel Access Tokens for authentication
- Authorization header:
Authorization: Bearer <TOKEN> - API supports HTTP/1 and HTTP/2 over SSL
- Base URL:
https://api.vercel.com - Developer docs: https://vercel.com/docs/rest-api
Key Endpoints
GET /v6/deployments- List deploymentsPOST /v13/deployments- Create a deploymentGET /v9/projects- List projectsGET /v6/domains- List domainsGET /v1/edge-config- Edge Config managementGET /v1/integrations- List integrationsGET /v9/projects/{id}/env- Environment variablesGET /v2/teams- List teamsGET /v1/security/checks- Security checks
Events to Track
- Deployments - Deployment created, deployment ready, deployment errored, deployment promoted
- Projects - Project created, project updated, project deleted
- Domains - Domain added, domain configured, domain verified, SSL issued
- Environment - Environment variable created, updated, deleted
- Team - Member invited, member removed, role changed
Implementation Tasks
- Set up basic integration structure following
integrations/github/src/index.tspattern - Implement token-based authentication in
account-create.ts - Create API utilities in
utils.tsfor Vercel API calls - Implement sync logic in
schedule.tsfor deployments, projects, and domains - Convert deployment events to CORE activity format
- Add error handling and rate limiting
- Create integration documentation
- Add to
integrations/README.md
Technical Notes
- Rate limits communicated via response headers:
X-RateLimit-Limit,X-RateLimit-Remaining,X-RateLimit-Reset - REST API documentation is automatically updated with API changes
- Supports any programming language or framework that can send HTTP requests
- Webhook integrations available for real-time deployment notifications
- API versioning via URL path (e.g.,
/v6/,/v13/)
Resources
- Vercel REST API Reference
- Using the REST API
- Building Integrations with Vercel
- REST API Interfaces
- Vercel CLI
Labels
enhancement, integration, new-feature