RevKeenDocs
StatusSupport
API Reference

Create a test event

Creates a simulated test event that triggers webhook delivery to configured endpoints. Useful for testing webhook integrations. --- **Related endpoints** - `GET /events` — List events - `GET /events/{id}` — Retrieve an event - `POST /events/{id}/resend` — Resend webhook for an event **Common errors** - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).

POST
/events/test

Creates a simulated test event that triggers webhook delivery to configured endpoints. Useful for testing webhook integrations.

Related endpoints

  • GET /events — List events
  • GET /events/{id} — Retrieve an event
  • POST /events/{id}/resend — Resend webhook for an event

Common errors

  • 401 authentication_error — missing, invalid, expired, or revoked credential. Codes: authentication_failed, invalid_api_key, expired_api_key, api_key_revoked, session_invalid, merchant_required. Carries a WWW-Authenticate: Bearer challenge.

Idempotency

Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.

Authorization

x-api-key<token>

Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Parameters for creating a test event to verify your webhook endpoint integration.

Response Body

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl -X POST "https://api.revkeen.com/v2/events/test" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "invoice.paid"
  }'
{  "success": true,  "event": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "object": "event",    "type": "string",    "data": {      "object": null,      "previous_attributes": null    },    "request": {      "id": "string",      "idempotency_key": "string"    },    "pending_webhooks": 0,    "api_version": "string",    "livemode": true,    "created": 0  },  "message": "string"}

List entitlements GET

Retrieve all entitlements for a customer. Pass `customer_id` as a query parameter. Includes computed access status based on subscription state. --- **Related endpoints** - `GET /customers/{customerId}/entitlements` — List customer entitlements - `POST /customers/{customerId}/entitlements` — Grant entitlement to customer - `DELETE /customers/{customerId}/entitlements` — Revoke entitlement by benefit key - `GET /customers/{customerId}/entitlements/check` — Check customer entitlement - `DELETE /customers/{customerId}/entitlements/{entitlementId}` — Revoke entitlement by ID - `GET /entitlements/check` — Check entitlement access **Common errors** - `400 invalid_request` — malformed payload or failed validation. - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. **Pagination** Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.

Retrieve an event GET

Retrieves the details of an event by its ID. --- **Related endpoints** - `GET /events` — List events - `POST /events/{id}/resend` — Resend webhook for an event - `POST /events/test` — Create a test event **Common errors** - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key.