Send test delivery

Trigger a webhook.test delivery signed with the same Standard Webhooks headers (webhook-id, webhook-timestamp, webhook-signature) as live events. Required API-key scope: webhooks_manage; the key’s owner must still be allowed to manage webhooks. A member session needs permission to manage webhooks or credentials.

POST /api/v1/workspaces/{workspaceId}/webhooks/{webhookId}/deliveries

Send a test delivery

cURL

curl --request POST \
  --url https://api.tetrafi.io/api/v1/workspaces/{workspaceId}/webhooks/{webhookId}/deliveries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{
  "kind": "test"
}'

201

{
  "attempt": 1,
  "deliveredAt": "2023-11-07T05:31:56Z",
  "eventType": "treasury.payout.awaiting_approval",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "success": true,
  "webhookId": "<string>",
  "errorMessage": "<string>",
  "payload": "<unknown>",
  "redeliverAvailable": true,
  "redeliveryOf": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "statusCode": 1,
  "test": true
}

Authorizations

bearer_authapi_key

Authorization · string · header · required

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

Scopes

webhooks_manage · bearer_auth

webhooks_manage · api_key

Headers

X-Workspace-Id · string<uuid>

The workspace the request acts in. An API key bound to a workspace implies it: omit the header, or send that same id (another id answers 403 WORKSPACE_SCOPE_MISMATCH). A member session must send it (400 MISSING_WORKSPACE without it).

Idempotency-Key · string · required

Required. Same key and kind replay the stored 201 delivery without a second send; different body is 409 IDEMPOTENCY_CONFLICT.

Path Parameters

workspaceId · string · required

Workspace ID

webhookId · string · required

Webhook ID

Body

application/json

Create a test delivery under an existing webhook.

kind · string · required

Only test deliveries may be created by clients. Other kinds are refused.

Pattern: ^test$

Example:

"test"

Response

201

application/json

Test delivery created, or stored delivery replayed

A delivery log entry for a webhook invocation.

attempt · integer<int32> · required

Required range: x >= 0

deliveredAt · string<date-time> · required

eventType · enum<string> · required

New values may be added; treat unknown values as other.

Available options: treasury.payout.awaiting_approval, treasury.payout.completed, treasury.payout.failed, treasury.payout.cancelled, treasury.payout.needs_checking, treasury.fiat_leg.planned, treasury.fiat_leg.awaiting_approval, treasury.fiat_leg.payout_held, treasury.fiat_leg.dispatching, treasury.fiat_leg.uncertain, treasury.fiat_leg.in_transit, treasury.fiat_leg.held_by_provider, treasury.fiat_leg.overdue, treasury.fiat_leg.manual_review, treasury.fiat_leg.settled, treasury.fiat_leg.returned, treasury.fiat_leg.returned_after_settlement, treasury.fiat_leg.refunding, treasury.fiat_leg.refunded, treasury.fiat_leg.cancelled, treasury.fiat_leg.refused, treasury.bank_deposit.declared, treasury.bank_deposit.overdue, treasury.bank_deposit.manual_review, treasury.bank_deposit.credited, treasury.bank_deposit.withdrawn_by_user, treasury.bank_deposit.history_unreadable, treasury.bank_deposit.history_recovered, treasury.fiat_leg.awaiting_funds, treasury.fiat_leg.funds_received, treasury.fiat_leg.price_beyond_bound, treasury.fiat_leg.expired_unfunded, treasury.fiat_leg.late_funds, treasury.transfer.submitted, treasury.transfer.awaiting_approval, treasury.transfer.rejected, treasury.transfer.completed, treasury.transfer.failed, treasury.transfer.cancelled, treasury.transfer.custodian_approval_relayed, treasury.transfer.expired, treasury.transfer.replaced, treasury.transfer.confirmation_threshold_set, treasury.run.draft, treasury.run.waiting_for_funds, treasury.run.awaiting_approval, treasury.run.ready, treasury.run.running, treasury.run.waiting, treasury.run.reconciling, treasury.run.needs_review, treasury.run.paused, treasury.run.succeeded, treasury.run.partially_succeeded, treasury.run.failed, treasury.run.recovering, treasury.run.recovered, treasury.run.cancelled, treasury.step.pending, treasury.step.ready, treasury.step.dispatching, treasury.step.waiting, treasury.step.reconciling, treasury.step.needs_review, treasury.step.paused, treasury.step.succeeded, treasury.step.partially_succeeded, treasury.step.failed, treasury.step.cancelled, treasury.step.custodian_cancel_requested, treasury.step.confirmation_threshold_set, treasury.step.custodian_approval_relayed, treasury.step.custodian_cancel_overridden, treasury.approval.requested, treasury.approval.expiring, treasury.approval.approved, treasury.approval.denied, treasury.approval.expired, treasury.destination.retired, treasury.workspace.frozen, treasury.balance.low, treasury.balance.recovered, treasury.statement.ready, treasury.automation.created, treasury.automation.updated, treasury.automation.activated, treasury.automation.paused, treasury.automation.resumed, treasury.automation.archived, treasury.agent.envelope.created, treasury.agent.envelope.updated, treasury.agent.kill_switch.activated, treasury.agent.session_signer.granted, treasury.agent.session_signer.revoked, treasury.agent.sponsor.changed, treasury.agent.payment.authorized, treasury.agent.payment.settled, treasury.agent.payment.refused, treasury.agent.payment.received, order.updated, settlement.window.ready, settlement.obligation.due, settlement.obligation.overdue, settlement.payment.matched, member.added, member.removed, api_key.rotated, api_key.revoked, api_key.expiring_soon, compliance.sanctions.flag_added, compliance.event, credit.updated, direct_user.created, direct_user.verification.pending, direct_user.verification.verified, direct_user.verification.rejected, wallet.session_signer.granted, wallet.session_signer.revoked, webhook.test

id · string<uuid> · required

success · boolean · required

webhookId · string · required

errorMessage · string | null

payload · any

Fiat payload example captured live from a persisted bank-deposit event (rfq 2ef31a1ea), not a delivery receipt. References retain the API's masks exactly.

redeliverAvailable · boolean | null

Actual retained availability, not permission to resend; redelivery revalidates.

redeliveryOf · string<uuid> | null

statusCode · integer<int32> | null

Required range: x >= 0

test · boolean