Skip to main content
POST
Create a webhook subscription

Authorizations

Authorization
string
header
required

API key (nlmca_live_…) or OAuth access token

Body

application/json
url
string
required

Absolute HTTPS endpoint that receives POSTed events. http://localhost and http://127.0.0.1 are accepted for local development only; hosts that resolve to private, loopback or link-local addresses are rejected.

Maximum string length: 2048
Example:

"https://example.com/hooks/nextlevel-mca"

events
enum<string>[]
required

Event types to deliver. An empty array subscribes to every event, including types added later.

Available options:
deal.created,
deal.stage_changed,
deal.funded,
deal.dead,
submission.sent,
submission.responded,
offer.received,
offer.primary_changed,
document.uploaded,
document.processed,
statement.analyzed,
advance.renewal_ready,
advance.status_changed,
business.created,
person.created
Example:
description
string

Label shown in Settings → Developers, e.g. the name of the system that consumes the events.

Maximum string length: 255
Example:

"Zapier — new deals"

Response

Created. data.secret is shown only in this response.

data
object
required
meta
object
required