RevKeenDocs
StatusSupport
API Reference
🔔 Webhooks & EventsWebhook Endpoints

Create webhook endpoint

Create a webhook endpoint to receive event notifications at the given URL. Returns the endpoint with its signing secret — store the secret securely, it is only shown once.

POST/webhook-endpoints

Create a webhook endpoint to receive event notifications at the given URL. Returns the endpoint with its signing secret — store the secret securely, it is only shown once.

Related endpoints

  • GET /webhook-endpoints — List webhook endpoints
  • GET /webhook-endpoints/{id} — Get webhook endpoint
  • PATCH /webhook-endpoints/{id} — Update webhook endpoint
  • DELETE /webhook-endpoints/{id} — Delete webhook endpoint
  • POST /webhook-endpoints/{id}/rotate-secret — Rotate signing secret
  • POST /webhook-endpoints/{id}/redeliver — Redeliver an event to this endpoint

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.
  • 409 conflict — Idempotency-Key collision with a different body, or a concurrent state-transition conflict.

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.

Response Body

application/json

application/json

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/webhook-endpoints" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/success",
    "enabled_events": [
      "example"
    ]
  }'

Synthetic documentation data, validated against the response schema; not a live API result.

{  "data": {    "id": "1b2c3d4e-5f6a-4b7c-9d8e-0f1a2b3c4d98",    "url": "https://example.com/webhooks/revkeen",    "description": "Production webhook endpoint",    "enabled_events": [      "invoice.paid",      "subscription.created"    ],    "status": "enabled",    "circuit_breaker_state": "closed",    "total_deliveries": 12,    "successful_deliveries": 12,    "failed_deliveries": 0,    "last_delivery_at": "2026-04-02T11:30:00.000Z",    "created_at": "2026-04-02T10:00:00.000Z",    "updated_at": "2026-04-02T10:05:00.000Z"  }}

Put this endpoint to work

Handle webhook events

Verify webhook signatures