RedPlanetHQ / RedPlanetHQ/core

New Integration: Vercel

Open
#495 0 comments 0 reactions 1 assignee View on GitHub

@harshithmullapudi is already working on this.

Since Mar 11, 2026.

enhancement good first issue integration new-feature new-integration
Dominant language
TypeScript
Stars
2k
Forks
194
Avg merge
12m
Merged PRs (30d)
2

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 system
  • integrations/linear/ - Project management integration
  • integrations/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 deployments
  • POST /v13/deployments - Create a deployment
  • GET /v9/projects - List projects
  • GET /v6/domains - List domains
  • GET /v1/edge-config - Edge Config management
  • GET /v1/integrations - List integrations
  • GET /v9/projects/{id}/env - Environment variables
  • GET /v2/teams - List teams
  • GET /v1/security/checks - Security checks

Events to Track

  1. Deployments - Deployment created, deployment ready, deployment errored, deployment promoted
  2. Projects - Project created, project updated, project deleted
  3. Domains - Domain added, domain configured, domain verified, SSL issued
  4. Environment - Environment variable created, updated, deleted
  5. Team - Member invited, member removed, role changed

Implementation Tasks

  • Set up basic integration structure following integrations/github/src/index.ts pattern
  • Implement token-based authentication in account-create.ts
  • Create API utilities in utils.ts for Vercel API calls
  • Implement sync logic in schedule.ts for 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

Labels

enhancement, integration, new-feature

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.