> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hookstream.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Create endpoint

Create a new webhook endpoint for an application. The signing secret is returned only once.

` POST /applications/{appId}/endpoints `

Create endpoint

Create a new webhook endpoint for an application. The signing secret is returned only once.

## Servers

- ` https://hookstream.io/v1 ` — Production

## Authentication

The operation accepts these alternatives. Schemes within one alternative are required together.

### Alternative 1

- ` apiKey `: ` apiKey `

  - Credential: ` X-API-Key ` in ` header `

  - API key (format: hs_live_<64hex> or hs_test_<64hex>)

### Alternative 2

- ` cookieAuth `: ` apiKey `

  - Credential: ` better-auth.session_token ` in ` cookie `

  - Session cookie (browser auth)

## Parameters

### ` appId ` (path, required)

Application ID

- ` value `: type ` string ` — Application ID

  - example: ` "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6" `

  - minLength: ` 1 `

Example:

```json
"a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
```

## Request body (required)

Content type: ` application/json `

Request body

- ` value `: type ` object `

  - Required fields: ` url `

  - ` url `: type ` string `; format ` uri ` — Webhook endpoint URL

    - example: ` "https://example.com/webhook" `

  - ` description `: type ` string ` — Description

  - ` filter_types `: type ` array ` — Event types to filter for

    - ` array item `: type ` string `

  - ` rate_limit_per_second `: type ` number ` — Per-second rate limit

  - ` expires_at `: type ` string ` — ISO expiry timestamp

## Responses

### ` 201 ` — Endpoint created (signing secret shown once)

Content type: ` application/json `

- ` value `: type ` object `

  - Required fields: ` endpoint `

  - ` endpoint `: type ` unknown `

    - ` allOf constraint 1 `: type ` object `

      - Required fields: ` id `, ` org_id `, ` env_id `, ` application_id `, ` url `, ` description `, ` signing_algorithm `, ` status `, ` filter_types `, ` rate_limit_per_second `, ` expires_at `, ` created_at `, ` updated_at `

      - ` id `: type ` string `

      - ` org_id `: type ` string `

      - ` env_id `: type ` string `

      - ` application_id `: type ` string `

      - ` url `: type ` string `

      - ` description `: type ` string `; nullable

      - ` signing_algorithm `: type ` string `

      - ` status `: type ` string `

      - ` filter_types `: type ` string `; nullable

      - ` rate_limit_per_second `: type ` integer `; nullable

      - ` expires_at `: type ` string `; nullable

      - ` created_at `: type ` string `

      - ` updated_at `: type ` string `

    - ` allOf constraint 2 `: type ` object `

      - Required fields: ` signing_secret `

      - ` signing_secret `: type ` string `

### ` 400 ` — Bad request

Content type: ` application/json `

- ` value `: type ` object `

  - Required fields: ` error `

  - ` error `: type ` string ` — Error message

### ` 401 ` — Unauthorized

Content type: ` application/json `

- ` value `: type ` object `

  - Required fields: ` error `

  - ` error `: type ` string ` — Error message

### ` 403 ` — Endpoint limit reached

Content type: ` application/json `

- ` value `: type ` object `

  - Required fields: ` error `

  - ` error `: type ` string `

  - ` upgrade_url `: type ` string `

### ` 404 ` — Application not found

Content type: ` application/json `

- ` value `: type ` object `

  - Required fields: ` error `

  - ` error `: type ` string ` — Error message

## Request examples

### cURL

```curl
curl -X POST 'https://hookstream.io/v1/applications/a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6/endpoints' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://example.com/webhook",
  "description": "string",
  "filter_types": [
    "string"
  ],
  "rate_limit_per_second": 0,
  "expires_at": "string"
}'
```

### JavaScript

```javascript
const response = await fetch('https://hookstream.io/v1/applications/a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6/endpoints', {
  method: 'POST',
  headers: {
      "Authorization": "Bearer YOUR_API_TOKEN",
      "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "url": "https://example.com/webhook",
    "description": "string",
    "filter_types": [
      "string"
    ],
    "rate_limit_per_second": 0,
    "expires_at": "string"
  })
});

const data = await response.json();
console.log(data);
```

### Python

```python
import requests

headers = {
    'Authorization': 'Bearer YOUR_API_TOKEN'
}

response = requests.post('https://hookstream.io/v1/applications/a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6/endpoints', headers=headers, json={
  "url": "https://example.com/webhook",
  "description": "string",
  "filter_types": [
    "string"
  ],
  "rate_limit_per_second": 0,
  "expires_at": "string"
})
print(response.json())
```

### Go

```go
package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{
  "url": "https://example.com/webhook",
  "description": "string",
  "filter_types": [
    "string"
  ],
  "rate_limit_per_second": 0,
  "expires_at": "string"
}`)
	req, _ := http.NewRequest("POST", "https://hookstream.io/v1/applications/a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6/endpoints", body)
	req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
	req.Header.Set("Content-Type", "application/json")

	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
	result, _ := io.ReadAll(resp.Body)
	fmt.Println(string(result))
}
```