Create project

POST

/v1/projects

• Production

Create a new project. Projects are containers for endpoints, API keys, and webhook messages.

Authorizations

• SessionAuth

Request Body ^required

object

name

required

Project name

string

>= 1 characters <= 255 characters

Example

Production Webhooks

rate_limit_default

Default rate limit (0 uses system default of 1000)

integer

Example

1000

Examples

Basic project

{
  "name": "Production Webhooks"
}

Project with custom rate limit

{
  "name": "High Volume Integration",
  "rate_limit_default": 5000
}

Responses

201

Project created successfully

object

data

object

id

Unique project identifier (UUIDv7)

string format: uuid

Example

01935abc-def0-7123-4567-890abcdef012

tenant_id

Tenant that owns this project

string

Example

tenant_abc123

name

Project name

string

Example

Production Webhooks

status

Project status

string

Allowed values: active suspended deleted

Example

active

rate_limit_default

Default rate limit for this project (requests per minute)

integer

Example

1000

created_at

string format: date-time

Example

2025-12-01T10:00:00Z

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

req_xyz123

Example

{
  "data": {
    "id": "01935abc-def0-7123-4567-890abcdef012",
    "tenant_id": "tenant_abc123",
    "name": "Production Webhooks",
    "status": "active",
    "rate_limit_default": 1000,
    "created_at": "2025-12-06T12:00:00Z"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

400

Invalid request

object

error

object

code

Machine-readable error code

string

Example

INVALID_REQUEST

message

Human-readable error message

string

Example

endpoint must be a valid HTTPS URL

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

req_xyz123

Examples

Endpoint not found

{
  "error": {
    "code": "ENDPOINT_NOT_FOUND",
    "message": "endpoint not found"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Invalid endpoint ID format

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "endpoint_id must be in format ep_xxx"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Invalid payload

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "payload must be valid JSON"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

Invalid headers

{
  "error": {
    "code": "INVALID_HEADERS",
    "message": "header 'Host' is forbidden and cannot be overridden"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

401

Unauthorized - Invalid or missing API key

object

error

object

code

Machine-readable error code

string

Example

INVALID_REQUEST

message

Human-readable error message

string

Example

endpoint must be a valid HTTPS URL

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

req_xyz123

Example

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}

429

Project limit reached

object

error

object

code

Machine-readable error code

string

Example

INVALID_REQUEST

message

Human-readable error message

string

Example

endpoint must be a valid HTTPS URL

meta

object

request_id

Unique identifier for this request (useful for support)

string

Example

req_xyz123

Example

{
  "error": {
    "code": "PROJECT_LIMIT_REACHED",
    "message": "Maximum number of projects reached for your plan"
  },
  "meta": {
    "request_id": "req_xyz123"
  }
}