Skip to main content
WEBHOOK
Sent when a tag is added to a household. Use household.id to identify the household; the top-level id is a generated event identifier. This payload has no event_type field. To identify the exact event name, configure a separate endpoint URL filtered to this event. 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.

​
id
string<uuid>
required

Generated event identifier. This is not the household ID.

​
household
object
required
​
tag_id
string
required

Opaque Slant record ID.

​
tag_name
string
required

Response

200

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