Register a webhook endpoint

post

https://sandbox.capvant.com/v1/webhooks

Registers an https endpoint. The host you register through decides its environment: an endpoint registered on sandbox.capvant.com only ever receives test deals; one registered on api.capvant.com receives every deal. New endpoints receive the full deal object in every delivery (payload: full) unless you choose reference.

Authorization

ApiKeyAuth

X-API-Key<token>

Lender keys start with cv_live_; Partner keys start with cv_pk_. Shown once at creation, sent on every request.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

url*string

Must be an https:// URL.

Formaturi

events?array<>

Defaults to all events.

payload?string

Push delivery mode. full (default) puts the complete deal object, exactly as GET /deals/{ref} returns it, into data on every delivery, plus the event's own detail (update, message, request, offer, completion), so you never have to call GET. reference sends only the deal ref and the few fields the event always carried.

Default"full"

Value in

"full"
"reference"

Response Body

`application/json`

Shell

curl -X POST "https://sandbox.capvant.com/webhooks" \  -H "Content-Type: application/json" \  -d '{    "url": "http://example.com"  }'

JSON

{  "id": "string",  "url": "http://example.com",  "events": [    "deal.created"  ],  "active": true,  "created_at": "2019-08-24T14:15:22Z",  "last_success_at": "2019-08-24T14:15:22Z",  "last_failure_at": "2019-08-24T14:15:22Z",  "failure_count": 0,  "payload": "full",  "environment": "live",  "secret": "string"}

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`