Webhook API Reference

Create, update and delete the webhooks that SQUAKE sends events to.

Creating a webhookCopy Anchor Link

To create a new webhook, send a POST request to the webhook endpoint.

EndpointCopy Anchor Link

POST /api/v2/webhooks

Request parametersCopy Anchor Link

HeadersCopy Anchor Link

• Authentication is required (based on the controller inheriting from BaseController)

RequestCopy Anchor Link

curl -X POST \
  https://api.squake.earth/v2/webhooks \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "kind": "order",
    "endpoint_url": "https://your-domain.com/webhook-receiver"
  }'

ResponseCopy Anchor Link

{
  "id": "webhook_id",
  "kind": "order",
  "endpoint_url": "https://your-domain.com/webhook-receiver",
  "signing_key": "webhook_signing_key",  // Only provided on creation
  "last_sent_at": null,
  "last_failed_at": null,
  "failed_attempts": 0
}

Updating a webhookCopy Anchor Link

Update an existing webhook configuration.

EndpointCopy Anchor Link

PUT /api/v2/webhooks/:id

Request parametersCopy Anchor Link

Example requestCopy Anchor Link

curl -X PUT \
  https://api.squake.earth/v2/webhooks/webhook_id \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "endpoint_url": "https://your-domain.com/new-webhook-receiver"
  }'

ResponseCopy Anchor Link

{
  "id": "webhook_id",
  "kind": "order",
  "endpoint_url": "https://your-domain.com/new-webhook-receiver"
}

Not found (404)Copy Anchor Link

Returned when the webhook ID doesn't exist or belongs to another client.

Deleting a webhookCopy Anchor Link

Remove an existing webhook configuration.

EndpointCopy Anchor Link

DELETE /api/v2/webhooks/:id

Example requestCopy Anchor Link

curl -X DELETE \
  https://api.squake.earth/v2/webhooks/webhook_id \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

Important notesCopy Anchor Link

1. The webhook signing key is only returned once during webhook creation. Make sure to store it securely.
2. The endpoint URL must be a valid HTTPS URL that can receive POST requests.
3. Each client can create multiple webhooks for different purposes.
4. Available webhook kinds:
   • order: Notifications about order-related events
   • confirmation_document_available: Notifications when confirmation documents become available
   • certificate_document_available: Notifications when certificate documents become available