API Reference›Servicing Plane›Webhooks›Create a webhook subscription

Create a webhook subscription

POSThttps://sandbox.api.lendeasy.ai/v1/servicing/webhook-subscriptionsRoadmapBearer token ·MANAGE_WEBHOOK

Creates a tenant-owned HTTPS subscription and returns the signing secret exactly once.

Roadmap contract. This operation is published product direction and is not registered by the current servicing runtime. Check API availability before building an integration.

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/webhook-subscriptions \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://events.example.test/lendeasy",
  "eventTypes": [
    "payment.posted",
    "payment.returned",
    "funding.posted",
    "case.transitioned"
  ],
  "apiVersion": "2026-07-01",
  "description": "Portfolio event consumer"
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/webhook-subscriptions`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "url": "https://events.example.test/lendeasy",
  "eventTypes": [
    "payment.posted",
    "payment.returned",
    "funding.posted",
    "case.transitioned"
  ],
  "apiVersion": "2026-07-01",
  "description": "Portfolio event consumer"
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/webhook-subscriptions",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "url": "https://events.example.test/lendeasy",
  "eventTypes": [
    "payment.posted",
    "payment.returned",
    "funding.posted",
    "case.transitioned"
  ],
  "apiVersion": "2026-07-01",
  "description": "Portfolio event consumer"
},
)

{
  "webhookSubscriptionId": "whsub_PORTFOLIO_7",
  "status": "pending_verification",
  "url": "https://events.example.test/lendeasy",
  "eventTypes": [
    "payment.posted",
    "payment.returned",
    "funding.posted",
    "case.transitioned"
  ],
  "apiVersion": "2026-07-01",
  "secretVersion": 2,
  "createdAt": "2026-08-01T18: 00:00Z",
  "version": 1,
  "signingSecret": "whsec_sandbox_once_7K2P"
}

{
  "type": "https://docs.lendeasy.ai/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

{
  "type": "https://docs.lendeasy.ai/errors/forbidden",
  "title": "Forbidden",
  "status": 403,
  "code": "forbidden",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

{
  "type": "https://docs.lendeasy.ai/errors/version_conflict",
  "title": "Version Conflict",
  "status": 409,
  "code": "version_conflict",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

{
  "type": "https://docs.lendeasy.ai/errors/validation_error",
  "title": "Validation Error",
  "status": 422,
  "code": "validation_error",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

{
  "type": "https://docs.lendeasy.ai/errors/rate_limited",
  "title": "Rate Limited",
  "status": 429,
  "code": "rate_limited",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

Path & query parameters

Field	Type	Description
Idempotency-Key required in header	string	Stable key for this one logical mutation. Reuse it for retries; reusing it with a different request returns 409.

Body parameters

Field	Type	Description
url required	string
eventTypes required	array<string>
apiVersion required	string
description required	string

Request

curl -X POST https://sandbox.api.lendeasy.ai/v1/servicing/webhook-subscriptions \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://events.example.test/lendeasy",
  "eventTypes": [
    "payment.posted",
    "payment.returned",
    "funding.posted",
    "case.transitioned"
  ],
  "apiVersion": "2026-07-01",
  "description": "Portfolio event consumer"
}'

await fetch(`https://sandbox.api.lendeasy.ai/v1/servicing/webhook-subscriptions`, {
  method: "POST",
  headers: { Authorization: `Bearer ${token}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json" },
  body: JSON.stringify({
  "url": "https://events.example.test/lendeasy",
  "eventTypes": [
    "payment.posted",
    "payment.returned",
    "funding.posted",
    "case.transitioned"
  ],
  "apiVersion": "2026-07-01",
  "description": "Portfolio event consumer"
}),
});

requests.post(
  f"https://sandbox.api.lendeasy.ai/v1/servicing/webhook-subscriptions",
  headers={"Authorization": f"Bearer {token}", "Idempotency-Key": idempotency_key},
  json={
  "url": "https://events.example.test/lendeasy",
  "eventTypes": [
    "payment.posted",
    "payment.returned",
    "funding.posted",
    "case.transitioned"
  ],
  "apiVersion": "2026-07-01",
  "description": "Portfolio event consumer"
},
)

{
  "webhookSubscriptionId": "whsub_PORTFOLIO_7",
  "status": "pending_verification",
  "url": "https://events.example.test/lendeasy",
  "eventTypes": [
    "payment.posted",
    "payment.returned",
    "funding.posted",
    "case.transitioned"
  ],
  "apiVersion": "2026-07-01",
  "secretVersion": 2,
  "createdAt": "2026-08-01T18: 00:00Z",
  "version": 1,
  "signingSecret": "whsec_sandbox_once_7K2P"
}

{
  "type": "https://docs.lendeasy.ai/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

{
  "type": "https://docs.lendeasy.ai/errors/forbidden",
  "title": "Forbidden",
  "status": 403,
  "code": "forbidden",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

{
  "type": "https://docs.lendeasy.ai/errors/version_conflict",
  "title": "Version Conflict",
  "status": 409,
  "code": "version_conflict",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

{
  "type": "https://docs.lendeasy.ai/errors/validation_error",
  "title": "Validation Error",
  "status": 422,
  "code": "validation_error",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}

{
  "type": "https://docs.lendeasy.ai/errors/rate_limited",
  "title": "Rate Limited",
  "status": 429,
  "code": "rate_limited",
  "detail": "The request could not be applied.",
  "requestId": "req_01J2R8M6YQ3C7K2N"
}