> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.livingbrain.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.livingbrain.com/_mcp/server.

# Register a webhook

POST https://api.livingbrain.com/v1/webhooks
Content-Type: application/json

Register a webhook endpoint and receive its signing secret. The secret is returned only on creation — store it immediately, as it cannot be retrieved again.

Reference: https://docs.livingbrain.com/api-reference/webhooks/create

## Authentication

- `x-api-key` header (required) — Your Living Brain API key. Create one from the dashboard; keys are scoped to an organization and carry the role of the member they were issued to.

## Request

### Body (application/json)

This endpoint expects a CreateWebhookReqDto.

- `url` (string, required) — HTTPS endpoint to deliver events to
- `events` (list of enum, optional) — Event types to subscribe to; empty = all
  - Allowed values: `brain.page.updated`, `brain.change.new`, `brain.connection.new`, `brain.brief.ready`, `brain.import.progress`
- `secret` (string, optional) — Signing secret to use for this subscription. When omitted a random secret is generated and returned once. Hosts that verify deliveries against a pre-configured secret (e.g. an env var) should pass it here so signatures match. Write-only: never returned on reads.

## Response

### 201

- `id` (string, required) — Subscription id
- `tenantId` (string, required) — Owning tenant id
- `url` (string, required) — Delivery endpoint
- `events` (list of enum, required) — Subscribed event types; empty = all
  - Allowed values: `brain.page.updated`, `brain.change.new`, `brain.connection.new`, `brain.brief.ready`, `brain.import.progress`
- `active` (boolean, required) — Whether the subscription is currently receiving deliveries.
- `createdAt` (datetime, required) — ISO 8601 timestamp of when this record was created.
- `updatedAt` (datetime, required) — ISO 8601 timestamp of when this record was last modified.
- `secret` (string, required) — Raw signing secret for verifying `x-brain-signature` on deliveries. Returned exactly once; store it now.

## Errors

### 400 Bad Request Error

Validation failed

- `statusCode` (integer, required) — HTTP status code
- `timestamp` (string, required) — ISO timestamp of the failure
- `path` (string, required) — Request path (query string stripped)
- `message` (string, required) — Human-readable error message
- `body` (ErrorResDtoBody, optional) — Original framework exception response when available, e.g. `{ statusCode, message, error }` with per-field validation messages

### 401 Unauthorized Error

Unauthorized

- `statusCode` (integer, required) — HTTP status code
- `timestamp` (string, required) — ISO timestamp of the failure
- `path` (string, required) — Request path (query string stripped)
- `message` (string, required) — Human-readable error message
- `body` (ErrorResDtoBody, optional) — Original framework exception response when available, e.g. `{ statusCode, message, error }` with per-field validation messages

### 403 Forbidden Error

Linked-project integrations are source-managed

- `statusCode` (integer, required) — HTTP status code
- `timestamp` (string, required) — ISO timestamp of the failure
- `path` (string, required) — Request path (query string stripped)
- `message` (string, required) — Human-readable error message
- `body` (ErrorResDtoBody, optional) — Original framework exception response when available, e.g. `{ statusCode, message, error }` with per-field validation messages

## Types

### ErrorResDtoBody

Original framework exception response when available, e.g. `{ statusCode, message, error }` with per-field validation messages

## Examples

**Request**

```json
{
  "url": "https://your-app.com/webhooks/living-brain"
}
```

**Response**

```json
{
  "id": "string",
  "tenantId": "string",
  "url": "string",
  "events": [
    "brain.page.updated"
  ],
  "active": true,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "secret": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.livingbrain.com/v1/webhooks"

payload = { "url": "https://your-app.com/webhooks/living-brain" }
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.livingbrain.com/v1/webhooks';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"url":"https://your-app.com/webhooks/living-brain"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.livingbrain.com/v1/webhooks"

	payload := strings.NewReader("{\n  \"url\": \"https://your-app.com/webhooks/living-brain\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.livingbrain.com/v1/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://your-app.com/webhooks/living-brain\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.livingbrain.com/v1/webhooks")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://your-app.com/webhooks/living-brain\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.livingbrain.com/v1/webhooks', [
  'body' => '{
  "url": "https://your-app.com/webhooks/living-brain"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.livingbrain.com/v1/webhooks");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"url\": \"https://your-app.com/webhooks/living-brain\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = ["url": "https://your-app.com/webhooks/living-brain"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.livingbrain.com/v1/webhooks")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```