> This page is for Paperwork API, version v1 (default).
> For other versions, use one of these documentation indexes:
> - v1 (default): https://docs.cloudraker.com/paperwork/v1/llms.txt

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

# Create a webhook endpoint

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

Saves a delivery target you can point any run at.

Reference it from a run as `webhook: { "id": "whe_…" }` — on [extract](https://docs.cloudraker.com/api/cloud-raker-api/capabilities/extract), [fill](https://docs.cloudraker.com/api/cloud-raker-api/capabilities/fill), [pipeline](https://docs.cloudraker.com/api/cloud-raker-api/capabilities/pipeline), any of them. Runs keep the *reference*, never a URL snapshot, so pausing or re-pointing an endpoint takes effect on runs already in flight.

```json
{
  "url": "https://example.com/hooks/cloudraker",
  "events": ["run.completed", "run.failed"]
}
```

**Event types** — omit `events` to receive all of them:

* `processing.started`
* `file.processed`
* `file.failed`
* `run.completed`
* `run.failed`
* `processing.completed`
* `processing.expired`
* `space.expired`
* `agent_run.waiting`
* `agent_run.needs_input`
* `agent_run.approval_requested`
* `agent_run.task_ready`
* `agent_run.completed`
* `agent_run.failed`
* `work_session.opened`
* `work_session.waiting`
* `work_session.done`
* `turn.started`
* `turn.finished`
* `turn.failed`
* `approval.requested`
* `approval.decided`
* `artifact.created`
* `artifact.committed`
* `embed.document_saved`
* `embed.document_approved`

**Delivery guarantees.** At-least-once, so dedupe on `eventId` — a retry re-sends the whole event to every target. Up to 6 attempts, at least ten seconds apart, then the event is dropped. Each attempt is signed ES256 — verify against [the public keys](https://docs.cloudraker.com/api/cloud-raker-api/webhooks/webhook-jwks), and check what actually landed with [the delivery log](https://docs.cloudraker.com/api/cloud-raker-api/webhooks/list-webhook-deliveries).

**Learn more:** [Webhooks guide](https://docs.cloudraker.com/developers/webhooks)

Reference: https://docs.cloudraker.com/paperwork/api/webhooks/create-webhook-endpoint

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Body (application/json)

This endpoint expects a V1CreateWebhookBody.

- `url` (string, required)
- `events` (list of enum, optional)
  - Allowed values: `processing.started`, `file.processed`, `file.failed`, `run.completed`, `run.failed`, `processing.completed`, `processing.expired`, `space.expired`, `agent_run.waiting`, `agent_run.needs_input`, `agent_run.approval_requested`, `agent_run.task_ready`, `agent_run.completed`, `agent_run.failed`, `work_session.opened`, `work_session.waiting`, `work_session.done`, `turn.started`, `turn.finished`, `turn.failed`, `approval.requested`, `approval.decided`, `artifact.created`, `artifact.committed`, `embed.document_saved`, `embed.document_approved`
- `disabled` (boolean, optional)

## Response

### 201

The endpoint.

- `object` ("webhook_endpoint", required)
- `id` (string, required)
- `url` (string, required)
- `disabled` (boolean, required)
- `createdAt` (string, required)
- `events` (list of string, optional)

## Errors

### 400 Bad Request Error

Invalid url or event type (`invalid_request`).

- `any`

### 429 Too Many Requests Error

Rate limited. The `/v1` API allows at least **67 requests per minute per organization** (about 1,000 requests per 15 minutes) — a guaranteed floor, enforced per edge location, so a geographically spread caller may get more. Wait for the `Retry-After` interval and retry — the error is `retryable`.

- `code` (enum, required)
  - Allowed values: `rate_limited`
- `message` (string, required)
- `retryable` (boolean, required)
- `requestId` (string, required)
- `docUrl` (string, optional)

## Examples

**Request**

```json
{
  "url": "https://example.com/hooks/cloudraker"
}
```

**Response**

```json
{
  "object": "string",
  "id": "whe_01JQ8ZKMRT4V6WXYZ0ABCDEFGH",
  "url": "string",
  "disabled": true,
  "createdAt": "string",
  "events": [
    "string"
  ]
}
```

**SDK Code**

```python
import requests

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

payload = { "url": "https://example.com/hooks/cloudraker" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.cloudraker.com/v1/webhooks';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"url":"https://example.com/hooks/cloudraker"}'
};

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.cloudraker.com/v1/webhooks"

	payload := strings.NewReader("{\n  \"url\": \"https://example.com/hooks/cloudraker\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.cloudraker.com/v1/webhooks")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://example.com/hooks/cloudraker\"\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.cloudraker.com/v1/webhooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://example.com/hooks/cloudraker\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.cloudraker.com/v1/webhooks', [
  'body' => '{
  "url": "https://example.com/hooks/cloudraker"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.cloudraker.com/v1/webhooks");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"url\": \"https://example.com/hooks/cloudraker\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["url": "https://example.com/hooks/cloudraker"] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.cloudraker.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()
```