Skip to main content
WEBHOOK
Sent when a relationship link between two records is created. id identifies the link; source_type/source_id and target_type/target_id identify its endpoints. This describes the relationship, not either record’s contents. 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
required

ID of the relationship link.

source_type
string
required
source_id
string
required

Opaque Slant record ID.

target_type
string
required
target_id
string
required

Opaque Slant record ID.

source_label
string | null
required
target_label
string | null
required
relationship_to_source
string | null
required

How the source relates to the target.

relationship_to_target
string | null
required

How the target relates to the source.

created_at
string<date-time>
required
updated_at
string<date-time>
required

Response

200

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