Skip to main content
PATCH
cURL

Authorizations

x-api-key
string
header
required

Your key id, VFN_TEST_… or VFN_LIVE_…. Sent on every request.

x-secret-key
string
header
required

Your secret, VFN_SK_…. Not a real header, and never sent to the API. It is only a form field for Try it, which uses it to sign your request in your browser. In your own code you sign each request with the secret and send x-api-key, x-timestamp and x-signature (see Authentication).

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the first answer (kept 24 h). Leave empty in Try it: a new one is made for every call.

Maximum string length: 255

Path Parameters

endpoint_id
string
required
Pattern: ^we_[a-f0-9]{32}$

Body

application/json
url
string

Your HTTPS endpoint (port 443, public host). Record POSTs each event here and counts any 2xx as the acknowledgement

Maximum string length: 2048
description
string
Maximum string length: 200
event_types
enum<string>[]
Required array length: 1 element
Available options:
candidate.result
status
enum<string>
Available options:
active,
paused

Response

The endpoint

success
boolean
message
string
data
object