Webhooks

Using SQUAKE Webhooks API to receive notifications about your customers' purchase-related events

What are Webhooks?

Webhooks are HTTP callbacks that notify your application when events happen in SQUAKE's system. Instead of continuously polling our API, webhooks push data to your endpoint when events occur.

Common Use Cases

• Payment status notifications

• Documents status updates (compensation confirmation/certificates are ready)

Implementation Guide

You can setup different webhooks for different kinds of events:

order - we’ll send you an event when purchase which was made via stripe changes status

confirmation_document_available - we’ll send a document when it’s generated

certificate_document_available - we’ll send a document when it’s generated

Validating incoming webhooks

When SQUAKE sends webhooks to your endpoint, we include a signature in the headers that allows you to verify that the request came from us. Here's how to validate the webhooks:

Headers

Each webhook request includes the following security-related headers:

• HTTP_SQUAKE_SIGNATURE: HMAC-SHA256 signature of the payload

• HTTP_SQUAKE_TIMESTAMP: ISO8601-formatted timestamp of when the webhook was sent

Validation Process

1. Get the raw request body as a string

2. Get the signature from the HTTP_SQUAKE_SIGNATURE header

3. Calculate the HMAC-SHA256 using your signing key:

# Example in Ruby
payload = request.raw_post  # Get raw request body
signature = OpenSSL::HMAC.hexdigest('SHA256', SIGNING_KEY, payload)

# Compare signatures (use secure comparison)
secure_compare(signature, request.headers['HTTP_SQUAKE_SIGNATURE'])

Request Body Format

The webhook payload is wrapped in a data object:

{
   "data": {
      // ... webhook payload ...
   }
}

Kinds of Webhooks

Order webhook

Type: order

Whenever you request a pricing using /pricing endpoint, it’s possible to pass a payment_method: "stripe" parameter. If it’s passed then we’ll return a paymet_link in the response:

https://checkout.squake.test?t=eyJhbGciOiJIUzI1NiJ9.eyJwIjoicHJpY2VfZFJTbmtVIiwiY3EiOjEuMCwiY3UiOiJ0b25uZSIsInQiOjEyMzMxLCJ0ZSI6MTIzMzEsImwiOiJlbiIsImMiOiJFVVIiLCJleHAiOjE3MzU4MTUzMTIsImZ0IjowLCJwbSI6InN0cmlwZSJ9.xO4V8-l4aPPJOAFYIjbUCiYRKbzyUZJYbf3j-umV-8A

You can add extra query parameters to this link in order to help you to track a specific purchase later, when you receive a webhook. One of the parameters you can pass is: external_reference .

If you’ll add it to the link:

https://checkout.squake.test?t=eyJhbGciOiJIUzI1NiJ9.eyJwIjoicHJpY2VfZFJTbmtVIiwiY3EiOjEuMCwiY3UiOiJ0b25uZSIsInQiOjEyMzMxLCJ0ZSI6MTIzMzEsImwiOiJlbiIsImMiOiJFVVIiLCJleHAiOjE3MzU4MTUzMTIsImZ0IjowLCJwbSI6InN0cmlwZSJ9.xO4V8-l4aPPJOAFYIjbUCiYRKbzyUZJYbf3j-umV-8A&external_reference=YOUR_EXTERNAL_REFERENCE

Then we’ll send it back to you in the webhook payload.

Whenever payment is done/cancelled/refunded, we’ll send you a webhook, here’s an example webhook payloads:

{
    "data": {
        "external_reference": "YOUR_EXTERNAL_REFERENCE",
        "purchase_id": "purchase_123456",
        "payment_status": "succeeded"
    }
}

Possible payment_status values:

complete - payment successfully completed canceled - payment is canceled failed - payment failed to process succeeded - payment is successful refunded - payment is refunded

Confirmation Document Available

Type: confirmation_document_available

Notifies you when a compensation confirmation document is ready for download.

Payload

{
    "data": {
        "purchase_id": "purchase_12345",
        "document_id": "file_UUID",
        "download_url": "https://api.squake.earth/documents/download/..."
    }
}

Certificate Document Available Webhook

Type: certificate_document_available

Notifies you when a certificate document is ready for download.

Payload

{
    "data": {
        "purchase_id": "purchase_12345",
        "document_id": "file_UUID",
        "download_url": "https://api.squake.earth/documents/download/..."
    }
}

Webhook API Reference

See Webhook API Reference for more details.