Webhook Subscriptions

Create webhook subscription

Changed on

Creates a new webhook subscription.

post/v1/webhook_subscriptions

Request

  • Base URL
    https://api.augustus.com
  • URL
    https://api.augustus.com/v1/webhook_subscriptions
  • Auth
    HTTP bearer

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.

Request body

urlstring uri required

The HTTPS URL where webhook events will be delivered.

eventsstring[] required

Event types to subscribe to. Use ["*"] for all events.

metadataobject nullable

Set of up to 50 key-value string pairs you can attach to store structured information, such as correlating this resource with an object in your own system. Keys may be up to 40 characters and values up to 500 characters.

Example request

{
  "url": "https://sandbox.example.com/webhooks/augustus",
  "events": [
    "payout.sent"
  ],
  "metadata": {
    "invoice_id": "INV-2026-0042"
  }
}

Response

Success

idstring required

Unique identifier of the webhook subscription.

type'webhook_subscription' required

Resource type discriminator.

urlstring required

The HTTPS URL where webhook events are delivered.

eventsstring[] required

Event types this subscription receives.

metadataobject required

Set of up to 50 key-value string pairs you can attach to store structured information, such as correlating this resource with an object in your own system. Keys may be up to 40 characters and values up to 500 characters.

created_atstring date-time required

ISO 8601 UTC timestamp when the subscription was created.

updated_atstring date-time required

ISO 8601 UTC timestamp when the subscription was last updated.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440009",
  "url": "https://sandbox.example.com/webhooks/augustus",
  "events": [
    "payout.sent"
  ],
  "metadata": {
    "invoice_id": "INV-2026-0042"
  },
  "created_at": "2026-01-15T10:30:00Z",
  "updated_at": "2026-01-15T10:35:00Z"
}

Changes