Skip to content
Documentation
Open app
Documentation/Getting started

Your first connection

Create your key, verify your connection and receive your first Kawlya event.

On this pageBefore you start1. Create an API key2. Verify the connection3. Subscribe to an event4. Test your receiver

Before you start

The integrations API connects your Kawlya workspace to your business tools. It powers the Kawlya apps for Zapier and Make and can also be called directly from your own code.

1. Create an API key

In your dashboard, open Integrations → API & Webhooks. Create a key and immediately copy it into your secrets manager. It is shown only once.

2. Verify the connection

Set KAWLYA_API_KEY in your environment. The key already identifies your workspace, so no additional account ID is needed.

Terminal
curl 'https://app.kawlya.com/api/integrations/v1/me' \
  -H "Authorization: Bearer $KAWLYA_API_KEY"
200 OK
{
  "tenant": {
    "id": 42,
    "name": "Garage Dupont"
  }
}

3. Subscribe to an event

Register your receiver’s public HTTPS URL and the events you want. This example tracks a new appointment.

Terminal
curl 'https://app.kawlya.com/api/integrations/v1/webhooks' \
  -H "Authorization: Bearer $KAWLYA_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"url":"https://your-domain.example/webhooks/kawlya","events":["reservation.created"],"source":"custom"}'

4. Test your receiver

Use events/sample to retrieve sample data. This request returns examples; it does not send a webhook to your URL. Verify signatures on real deliveries and respond within 10 seconds.

Terminal
curl 'https://app.kawlya.com/api/integrations/v1/events/sample?event=reservation.created&limit=1' \
  -H "Authorization: Bearer $KAWLYA_API_KEY"
Updated