Skip to main content
POST
/
v1
/
webhook_subscriptions
/
{id}
/
send_test_event
JavaScript
import Augustus from '@augustusbank/typescript-sdk';

const client = new Augustus({
  apiKey: process.env['AUGUSTUS_API_KEY'], // This is the default and can be omitted
});

const response = await client.webhookSubscriptions.sendTestEvent(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response.id);
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "event",
  "event_type": "payout.created",
  "api_version": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "data": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.augustus.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer token for authentication with Augustus Banking API

Headers

​
Idempotency-Key
string

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.

Path Parameters

​
id
string<uuid>
required

Unique identifier of the webhook subscription.

Response

200 - application/json

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

​
id
string<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
enum<string>
required

Resource type discriminator.

Available options:
event
​
event_type
enum<string>
required

Event type.

Available options:
payout.created,
payout.initiated,
payout.paid,
payout.failed,
return.initiated,
return.paid,
return.failed,
return.returned,
deposit.received,
conversion.created,
conversion.completed,
conversion.failed,
ping.test
​
api_version
string
required

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

​
created_at
string<date-time>
required

ISO 8601 UTC timestamp when the event was created.

​
data
object
required

Event payload. Shape matches the resource schema for event_type.