Skip to main content
POST
Create a webhook endpoint

Authorizations

x-api-key
string
header
required

Your API key, from the API keys page of the app.

Body

application/json
url
string
required

Where LeadVector POSTs the events: an https URL whose host resolves to public addresses.

Maximum string length: 2048
Example:

"https://hooks.example.com/leadvector"

eventTypes
string[]
required

The event types to receive (GET /v1/webhooks/event-types), or ["*"] for every type, including types added later.

Example:
filters
object
description
string | null

A note for the team: what the endpoint is for.

Maximum string length: 255
Example:

"Replies to our CRM"

Response

success
boolean
required
Example:

true

message
string
required
Example:

"WEBHOOK_CREATED"

data
object
required