Skip to navigation
Paperwork APIWebhooks

Create a webhook endpoint

View as Markdown

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.

{
  "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

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

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 stringsOptional

Errors

400
Bad Request Error
429
Too Many Requests Error