Skip to main content
WEBHOOK
invoice.paid
{
  "id": "whev_abc123",
  "type": "invoice.paid",
  "created_at": "2025-01-15T10:30:00Z",
  "api_version": "v1",
  "data": {
    "id": "inv_abc123",
    "amount": 4900,
    "currency": "usd",
    "status": "paid",
    "paid_at": "2025-01-15T10:30:00Z",
    "created_at": "2025-01-15T10:30:00Z",
    "customer": {
      "id": 42,
      "name": "Jane Doe",
      "email": "jane@example.com"
    },
    "line_items": [
      {
        "description": "Consulting retainer",
        "quantity": 1,
        "amount": 4900
      }
    ]
  }
}

Headers

​
X-Crevio-Hmac-SHA256
string
required

Base64-encoded HMAC-SHA256 of the raw request body, keyed with your endpoint's signing secret. Verify this before processing the event.

Body

application/json

Event payload Crevio POSTs to your endpoint.

​
id
string
required

Unique identifier for this webhook event

Example:

"whev_abc123"

​
type
enum<string>
required

The event type

Available options:
invoice.paid
Example:

"invoice.paid"

​
created_at
string<date-time>
required

ISO 8601 timestamp of when the event was created

Example:

"2025-01-15T10:30:00Z"

​
api_version
string
required

API version used to generate the payload

Example:

"v1"

​
data
object
required

The serialized invoice for this event

Response

200

Return any 2xx status within 5 seconds to acknowledge receipt.