> 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` **Delivery guarantees.** At-least-once, so dedupe on `eventId`. Up to 5 attempts with backoff, each 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/api/cloud-raker-api/webhooks/create-webhook-endpoint ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: CloudRaker API version: 1.0.0 paths: /v1/webhooks: post: operationId: create-webhook-endpoint summary: Create a webhook endpoint description: >- 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` **Delivery guarantees.** At-least-once, so dedupe on `eventId`. Up to 5 attempts with backoff, each 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) tags: - webhooks parameters: - name: Authorization in: header description: Bearer authentication required: true schema: type: string responses: '201': description: The endpoint. content: application/json: schema: $ref: '#/components/schemas/V1WebhookEndpoint' '400': description: Invalid url or event type (`invalid_request`). content: application/json: schema: description: Any type '429': description: >- 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`. content: application/json: schema: $ref: >- #/components/schemas/CreateWebhookEndpointRequestTooManyRequestsError requestBody: content: application/json: schema: $ref: '#/components/schemas/V1CreateWebhookBody' servers: - url: https://api.cloudraker.com description: Production - url: https://api.staging.raker.one description: Staging - url: https://api.dev.raker.one description: Development components: schemas: V1CreateWebhookBodyEventsItems: type: string enum: - processing.started - file.processed - file.failed - run.completed - run.failed - processing.completed - processing.expired title: V1CreateWebhookBodyEventsItems V1CreateWebhookBody: type: object properties: url: type: string format: uri events: type: array items: $ref: '#/components/schemas/V1CreateWebhookBodyEventsItems' disabled: type: boolean required: - url title: V1CreateWebhookBody V1WebhookEndpoint: type: object properties: object: type: string enum: - webhook_endpoint id: type: string url: type: string events: type: array items: type: string disabled: type: boolean createdAt: type: string required: - object - id - url - disabled - createdAt title: V1WebhookEndpoint V1WebhooksPostResponsesContentApplicationJsonSchemaCode: type: string enum: - rate_limited title: V1WebhooksPostResponsesContentApplicationJsonSchemaCode CreateWebhookEndpointRequestTooManyRequestsError: type: object properties: code: $ref: >- #/components/schemas/V1WebhooksPostResponsesContentApplicationJsonSchemaCode message: type: string retryable: type: boolean requestId: type: string docUrl: type: string required: - code - message - retryable - requestId title: CreateWebhookEndpointRequestTooManyRequestsError securitySchemes: bearerAuth: type: http scheme: bearer ``` ## Examples **Request** ```json { "url": "https://hooks.myapp.com/cloudraker" } ``` **Response** ```json { "object": "webhook_endpoint", "id": "whe_01JQ8ZKMRT4V6WXYZ0ABCDEFGH", "url": "https://hooks.myapp.com/cloudraker", "disabled": false, "createdAt": "2024-06-01T12:00:00Z", "events": [ "processing.started", "run.completed", "run.failed" ] } ``` **SDK Code** ```python import requests url = "https://api.cloudraker.com/v1/webhooks" payload = { "url": "https://hooks.myapp.com/cloudraker" } headers = { "Authorization": "Bearer ", "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 ', 'Content-Type': 'application/json'}, body: '{"url":"https://hooks.myapp.com/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://hooks.myapp.com/cloudraker\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") 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 ' request["Content-Type"] = 'application/json' request.body = "{\n \"url\": \"https://hooks.myapp.com/cloudraker\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.cloudraker.com/v1/webhooks") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"url\": \"https://hooks.myapp.com/cloudraker\"\n}") .asString(); ``` ```php request('POST', 'https://api.cloudraker.com/v1/webhooks', [ 'body' => '{ "url": "https://hooks.myapp.com/cloudraker" }', 'headers' => [ 'Authorization' => 'Bearer ', '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 "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"url\": \"https://hooks.myapp.com/cloudraker\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["url": "https://hooks.myapp.com/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() ```