API Keys & Webhooks

Generating an API Key

1. Go to Admin > API Keys and click Generate New Key.
2. Give the key a descriptive name (e.g., "Website Integration", "Mobile App").
3. Select the scopes (permissions) the key should have: read-only, read-write, or specific modules (People, Giving, Events).
4. Click Create. The full key is shown only once. Copy it immediately and store it securely.

Using the API

Include your API key in the Authorization header:

curl -H "Authorization: Bearer sk_live_your_key_here" \
     https://yourdomain.com/api/v1/people

Setting Up Webhooks

Webhooks allow SteepleOS to notify your external systems when events occur.

1. Go to Admin > Webhooks and click Add Endpoint.
2. Enter your endpoint URL (e.g., https://yourapp.com/webhooks/steepleos).
3. Select which events to subscribe to: person.created, donation.completed, event.checkin, etc.
4. SteepleOS signs each webhook payload with a secret so you can verify authenticity.

Testing Webhooks

Use the Send Test Event button on the webhook configuration page. This sends a sample payload to your endpoint so you can verify your server processes it correctly before going live.