Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cubestack.app/llms.txt

Use this file to discover all available pages before exploring further.

Webhooks Endpoints

Endpoints for creating and managing webhooks that notify your systems when data changes.

List Webhooks

Retrieve all webhooks for a project.
GET /api/v1/{project}/webhooks
X-Api-Key
string
required
Your API key

Response

{
  "data": [
    {
      "id": "wh_123",
      "url": "https://example.com/webhook",
      "events": ["record.created", "record.updated"],
      "active": true
    }
  ]
}

Create Webhook

Register a new webhook.
POST /api/v1/{project}/webhooks

Request Body

{
  "url": "https://example.com/webhook",
  "events": ["record.created", "record.updated", "record.deleted"]
}

Webhook Events

EventDescription
record.createdA new record was created
record.updatedA record was updated
record.deletedA record was deleted

Webhook Payload

{
  "event": "record.created",
  "project": "my-project",
  "cube": "blog-posts",
  "record": {
    "id": 1,
    "title": "New Post"
  },
  "timestamp": "2025-01-01T00:00:00Z"
}

Delete Webhook

DELETE /api/v1/{project}/webhooks/{webhook_id}