Sign in
Webhook Subscriptions

Send a test delivery

Sends a signed test event and records the delivery attempt.

post/webhooks/{webhookId}/test-delivery

Request

  • Base URL: https://next-api.saturation.io/v1
  • URL: https://next-api.saturation.io/v1/webhooks/{webhookId}/test-delivery
  • Auth: HTTP bearer

Path parameters

webhookIdstring required

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

Example:txn_8f2a1c9e

Webhook subscription identifier (whk_…).

Response

The queued test delivery.

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.

status'pending' | 'success' | 'failed' | 'blocked' | 'dropped' required

Outcome of a delivery. pending may be retried. success, failed, blocked, and dropped are final.

entityKindstring required

The kind of entity the event concerns (e.g. transaction, budget, purchaseOrder, document).

entityIdstring required

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

requestUrlstring uri

URL used for the delivery.

responseStatusinteger

HTTP status returned by the endpoint, when available.

attemptsinteger required

Number of delivery attempts.

nextRetryAtstring date-time

Time of the next retry. Present only while the delivery is pending.

errorstring

Failure details when the delivery did not succeed.

occurredAtstring date-time required

ISO-8601 timestamp of when the originating event occurred.

deliveredAtstring date-time

ISO-8601 timestamp of the terminal attempt. Absent while pending.

Example response

{
  "id": "txn_8f2a1c9e",
  "entityKind": "transaction",
  "entityId": "txn_8f2a1c9e",
  "requestUrl": "https://hooks.example.com/saturation",
  "responseStatus": 200,
  "attempts": 1
}

Changes

No recorded changes to this operation across all 4 revisions of this API.