Webhooks

Create a webhook subscription

Creates a subscription that receives application/json POST requests for the chosen event types. Each delivery includes:

X-Impreza-Signature: sha256=<hex> — HMAC-SHA256 of the raw body using the subscription's secret.
X-Impreza-Event — concrete event type
X-Impreza-Event-Id — unique event identifier (evt_...)
X-Impreza-Delivery-Attempt — delivery attempt counter

The secret is returned once in the response. Store it securely; it cannot be retrieved later. Use POST /webhooks/{id}/rotate-secret to generate a new one.

Subscriptions support wildcards: vps.* matches every VPS event, * matches everything.

On creation, a webhook.test probe event is enqueued for delivery so you can verify your endpoint works.

post/webhooks

Request

Base URL: https://api.imprezahost.com/v1
URL: https://api.imprezahost.com/v1/webhooks
Auth: API key in header X-API-Key and API key in header X-API-Secret

Request body

urlstring uri required

eventsstring[] required

descriptionstring

Example request

{
  "url": "https://example.com/hooks/impreza",
  "events": [
    "vps.*",
    "invoice.paid",
    "topup.paid"
  ],
  "description": "production handler"
}

Response

Subscription created — secret returned ONCE

Changes

No recorded changes to this operation across all 1 revision of this API.