Skip to main content
WEBHOOK
Sent when a note is created. Initial content and tags do not also emit note.updated. The snapshot is prepared asynchronously and may reflect changes made after the triggering event. Use its updated_at to reconcile local state. The envelope includes applicable parent IDs. Retrieve notes through /v1/households/{household_id}/notes/{id}, /v1/contacts/{contact_id}/notes/{id}, or /v1/businesses/{business_id}/notes/{id}; there is no top-level note endpoint. Verify the raw request body before processing. See the webhook overview for signing, retries, subscription context, and ordering.

Headers

​
svix-id
string
required

Delivery message ID. Use for idempotency; overlapping subscriptions have distinct IDs.

​
svix-timestamp
string
required

Unix timestamp used for signature verification.

​
svix-signature
string
required

Signature(s) to verify with the endpoint signing secret and a Svix verification library.

Body

application/json

JSON payload sent to your configured webhook endpoint.

​
subscription_id
string
required

Subscription that caused this delivery.

​
user_id
string
required

Subscribed Slant user.

​
book_id
string
required

Book containing the record.

​
company_id
string
required

Company that owns the book.

​
event_type
string
required
Allowed value: "note.created"
​
id
string
required

ID of the affected note.

​
note
object
required
​
household_id
string

Present when the note belongs to this parent.

​
contact_id
string

Present when the note belongs to this parent.

​
business_id
string

Present when the note belongs to this parent.

Response

200

Return a successful 2xx response promptly after verifying and durably accepting the delivery. Non-success responses can cause retries.