HOhookdeck
Projects

Create a project

Changed on

Create a new project within an organization. An organization API key restricted to selected projects is automatically granted access to the project it creates.

post/projects

Request

  • Base URL
    https://api.hookdeck.com/2025-07-01
  • Auth
    • HTTP bearer
    • or HTTP basic

Request body

namestring
organization_idstring
privateboolean
mode'outpost'

Example request

{
  "name": "Staging",
  "organization_id": "org_9bML1qH2vXp3",
  "mode": "outpost"
}

Response

The created project

idstring required

The project ID

organization_idstring required

The organization ID

namestring required

The project name

type'event_gateway' | 'console' | 'outpost' required

The project type

privateboolean required

Whether the project is private

is_guestboolean required

Whether the project is a guest project

static_ip_proxyboolean required

Whether static IP proxy is enabled

notification_methodsstring[] required

Notification methods enabled for the project

webhook_topicsstring[] required

Webhook notification topics

webhook_source_idstring nullable required

The source ID for webhook notifications

custom_hostnamesstring[] required

Custom hostnames attached to the project

directory_sync_enabledboolean required

Whether project members are provisioned from a directory group

headers_prefixstring nullable required

Prefix for Hookdeck headers

max_events_per_secondnumber float required

Maximum events per second for the project

updated_atstring required

Last update timestamp

created_atstring required

Creation timestamp

Example response

{
  "id": "tm_7yKd3nF0pQ2a",
  "organization_id": "org_9bML1qH2vXp3",
  "name": "Production",
  "type": "event_gateway",
  "notification_methods": [
    "email"
  ],
  "webhook_topics": [],
  "custom_hostnames": [],
  "headers_prefix": "X-Production",
  "max_events_per_second": 100,
  "notification_preferences": {
    "project_throughput_exceed": true
  },
  "updated_at": "2025-06-01T12:00:00.000Z",
  "created_at": "2025-01-15T08:30:00.000Z"
}

Changes