Quickstart

This is the fastest path from zero to first success with the RevKeen REST API.

1. Create a staging key

Create a non-production key in the RevKeen Dashboard.

• Create a new key for staging or integration work.
• Store it in an environment variable on your server.
• Do not expose it in browser code or mobile apps.

export REVKEEN_API_KEY=rk_sandbox_your_api_key

2. Make your first API call

Start with a safe read request against staging:

curl https://staging-api.revkeen.com/v2/customers \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Accept: application/json"

If the key and environment match, you will get a 200 OK response with a list payload.

3. Register one webhook endpoint

Create a staging webhook endpoint that subscribes to customer.created.

curl https://staging-api.revkeen.com/v2/webhook-endpoints \
  -X POST \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/webhooks/revkeen",
    "enabled_events": ["customer.created"],
    "description": "Staging webhook endpoint"
  }'

Store the returned signing secret securely. You will need it to verify the X-RevKeen-Signature header on incoming deliveries.

4. Trigger one event

Create a customer in staging to trigger the webhook you just subscribed to:

curl https://staging-api.revkeen.com/v2/customers \
  -X POST \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "quickstart@example.com",
    "name": "Quickstart Customer"
  }'

Confirm that your endpoint receives a customer.created event and that your consumer:

• verifies the signature
• logs the event ID
• returns 2xx quickly

5. Choose the next surface