Sign in

Receive a Saturation event

Saturation sends this request to a webhook subscription URL.

postWebhooksaturationEvent

Headers

X-Saturation-Signaturestring required
X-Saturation-Timestampstring date-time required
X-Saturation-Delivery-Idstring required

A stable resource ID, such as prj_…, txn_…, or doc_….

Example:txn_8f2a1c9e
X-Saturation-Event'transaction.created' | 'transaction.updated' | 'budget.changed' | 'purchaseOrder.created' | 'purchaseOrder.pending' | 'purchaseOrder.approved' | 'purchaseOrder.rejected' | 'purchaseOrder.actualizing' | 'purchaseOrder.paid' | 'purchaseOrder.void' | 'document.created' | 'document.linked' | 'document.unlinked' | 'document.deleted' | 'incentive.added' | 'pack.installed' | 'pack.uninstalled' | 'ping' required

Event recorded for a delivery. ping is used by test deliveries.

Payload

idstring required

A stable resource ID, such as prj_…, txn_…, or doc_….

event'transaction.created' | 'transaction.updated' | 'budget.changed' | 'purchaseOrder.created' | 'purchaseOrder.pending' | 'purchaseOrder.approved' | 'purchaseOrder.rejected' | 'purchaseOrder.actualizing' | 'purchaseOrder.paid' | 'purchaseOrder.void' | 'document.created' | 'document.linked' | 'document.unlinked' | 'document.deleted' | 'incentive.added' | 'pack.installed' | 'pack.uninstalled' | 'ping' required

Event recorded for a delivery. ping is used by test deliveries.

workspaceIdstring required

A stable resource ID, such as prj_…, txn_…, or doc_….

workspaceNamestring

Workspace name when available.

projectIdstring

A stable resource ID, such as prj_…, txn_…, or doc_….

projectNamestring

Project name when available.

occurredAtstring date-time required

ISO-8601 timestamp of the originating change.

Example payload

{
  "id": "txn_8f2a1c9e",
  "workspaceId": "txn_8f2a1c9e",
  "projectId": "txn_8f2a1c9e",
  "data": {
    "kind": "transaction",
    "id": "txn_8f2a1c9e"
  }
}

Response

Event accepted.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.