Subscribe an endpoint

post

https://sandbox.capvant.com/partner/v1/webhook-subscriptions

Returns the signing secret exactly once. The URL must be a public https endpoint; loopback and private ranges are refused.

Authorization

AuthorizationBearer <token>

An access token from POST /oauth/token. Valid for one hour. Preferred, because a leaked request log then exposes an hour rather than a permanent credential.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

url*string

Public https endpoint. Loopback and private ranges are refused.

events?array<>

Defaults to every event in the catalogue.

active?boolean

Defaults to true.

Response Body

`application/json`

`application/problem+json`

Callbacks

Shell

curl -X POST "https://sandbox.capvant.com/webhook-subscriptions" \  -H "Content-Type: application/json" \  -d '{    "url": "string"  }'

JSON

{  "id": "string",  "url": "string",  "events": [    "lead.created"  ],  "active": true,  "created_at": "string",  "last_success_at": "string",  "last_failure_at": "string",  "failure_count": 0,  "secret": "string",  "signature_header": "string",  "note": "string"}

Authorization

Request Body

Response Body

201application/json

401application/problem+json

403application/problem+json

404application/problem+json

409application/problem+json

415application/problem+json

422application/problem+json

429application/problem+json

500application/problem+json

Callbacks

partnerEventPOST{$request.body#/url}

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`