Webhook Subscriptions

Send test event

Changed on

Dispatches a signed ping.test event to this subscription's URL through the same pipeline as real events. Useful for verifying your receiver's reachability and signature verification in any environment without creating a real business event. Test-event failures do not affect the subscription's health counters or trigger failure-notification emails.

post/v1/webhook_subscriptions/{id}/send_test_event

Request

  • Base URL
    https://api.augustus.com
  • URL
    https://api.augustus.com/v1/webhook_subscriptions/{id}/send_test_event
  • Auth
    HTTP bearer

Path parameters

idstring uuid required
Example:550e8400-e29b-41d4-a716-446655440009

Unique identifier of the webhook subscription.

Headers

Idempotency-Keystring required

Idempotency key for safe retries. Reusing a key with an identical request body returns the cached response. Reusing a key with a different body returns 409.

Response

The newly created webhook event. Poll its delivery via GET /v1/webhook_deliveries?event_id={id} for receiver status.

idstring uuid required

Unique identifier of the event. Matches the envelope id delivered in the webhook payload and is stable across subscription fan-out and retries.

type'event' required

Resource type discriminator.

event_type'payout.initiated' | 'payout.submitted' | 'payout.sent' | 'payout.failed' | 'payout.returned' | 'return.initiated' | 'return.submitted' | 'return.sent' | 'return.failed' | 'return.returned' | 'deposit.settled' | 'conversion.created' | 'conversion.completed' | 'conversion.failed' | 'account_holder.active' | 'account_holder.closed' | 'counterparty.pending' | 'counterparty.active' | 'counterparty.rejected' | 'counterparty.blocked' | 'counterparty.unblocked' | 'counterparty.updated' | 'payout_tracking_event.created' | 'ping.test' required

Event type.

api_versionstring required

API version the event payload was rendered at. Stable across retries and redeliveries, and mirrored in the webhook envelope api_version field.

created_atstring date-time required

ISO 8601 UTC timestamp when the event was created.

dataobject required

Event payload. Shape matches the resource schema for event_type.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440008",
  "api_version": "2026-05-01",
  "created_at": "2026-01-15T10:30:00Z"
}

Changes

  • f7ded6c181abRevision changes
    • info

      endpoint added

  • e5198bf3cf7eRevision changes
    • warning

      added the new account_holder.active enum value to the response property for the response status

    • warning

      added the new account_holder.closed enum value to the response property for the response status