Create a webhook endpoint

POST

/v1/webhooks

Saves a delivery target you can point any run at.

Reference it from a run as webhook: { "id": "whe_…" } — on extract, fill, 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.

1 {
2   "url": "https://example.com/hooks/cloudraker",
3   "events": ["run.completed", "run.failed"]
4 }

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, and check what actually landed with the delivery log.

Learn more: Webhooks guide

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)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

urlstringRequiredformat: "uri"

eventslist of enumsOptional

disabledbooleanOptional

Response

The endpoint.

object"webhook_endpoint"

idstring

urlstring

disabledboolean

createdAtstring

eventslist of strings

Errors

400

Bad Request Error

429

Too Many Requests Error

$	curl -X POST https://api.cloudraker.com/v1/webhooks \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"url": "https://hooks.myapp.com/cloudraker"
>	}'

1	{
2	"object": "webhook_endpoint",
3	"id": "whe_01JQ8ZKMRT4V6WXYZ0ABCDEFGH",
4	"url": "https://hooks.myapp.com/cloudraker",
5	"disabled": false,
6	"createdAt": "2024-06-01T12:00:00Z",
7	"events": [
8	"processing.started",
9	"run.completed",
10	"run.failed"
11	]
12	}

1	{
2	"url": "https://example.com/hooks/cloudraker",
3	"events": ["run.completed", "run.failed"]
4	}