Register a webhook endpoint

Request

Register an HTTPS endpoint to receive event deliveries. The signing secret is returned ONCE in this response and never again — store it securely. Private/loopback URLs are rejected.

Security

ApiKeyAuth

Idempotency-Keystring, <= 255 characters

Optional opaque key (e.g. a UUID) to make this write safely retryable. A replay with the same key returns the original response instead of repeating the side effect.

Bodyapplication/jsonrequired

namestring, [ 1 .. 100 ] charactersrequired

urlstring, (starts_with)^https:\/\/.*required

HTTPS URL; private/loopback/metadata hosts are rejected.

subscribedEventsArray of strings, non-emptyrequired

Items Enum:"loan.created""loan.status_changed""loan.funded""document.uploaded""document.signed"

curl -i -X POST \
  https://api.pioneerft.com/api/public/v1/webhook-endpoints \
  -H 'Authorization: Bearer <YOUR_API Key_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: string' \
  -d '{
    "name": "string",
    "url": "string",
    "subscribedEvents": [
      "loan.created"
    ]
  }'

Responses

Endpoint created (includes the one-time signing secret)

Bodyapplication/json

dataobject(PublicWebhookEndpointWithSecret)

Response

{
  "data": {
    "id": "string",
    "name": "string",
    "url": "string",
    "environment": "string",
    "status": "string",
    "subscribedEvents": [
      "string"
    ],
    "consecutiveFailures": 0,
    "lastSuccessAt": "string",
    "lastFailureAt": "string",
    "lastFailureReason": "string",
    "autoDisabledAt": "string",
    "createdAt": "string",
    "secret": "string"
  }
}