Skip to main content
POST
Create a new webhook
You’re viewing API version 2026-09, which is deprecated and stops working on October 1, 2027. To see the current version, select 2026-10 in the menu at the top of the sidebar. To move your integration, see Upgrading to 2026-10.

Authorizations

Authorization
string
header
required

Personal API key, e.g. Authorization: Bearer sajn_sk_.... Not scope-limited — acts as the issuing user.

Headers

authorization
string
required

Bearer token for API authentication

Idempotency-Key
string

Makes retries safe. A retry with the same key and the same request replays the stored response for 24 hours (header Idempotent-Replayed: true); the same key with a different request returns 400.

Maximum string length: 255

Body

application/json

Body

Create webhook request

webhookUrl
string<uri>
required

URL that will receive webhook events

eventTriggers
enum<string>[]
required

List of event types to subscribe to

Minimum array length: 1
Available options:
DOCUMENT_CREATED,
DOCUMENT_SENT,
DOCUMENT_SIGNED,
DOCUMENT_COMPLETED,
DOCUMENT_REJECTED,
DOCUMENT_EXPIRED,
DOCUMENT_WITHDRAWN,
DOCUMENT_MODIFIED,
DOCUMENT_DELETED,
DOCUMENT_RESTORED,
DOCUMENT_ARCHIVED,
DOCUMENT_UNARCHIVED,
DOCUMENT_EXPIRATION_EXTENDED,
DOCUMENT_PARTY_SENT,
DOCUMENT_PARTY_DELIVERY_FAILED,
DOCUMENT_PARTY_OPENED,
DOCUMENT_PARTY_READ,
DOCUMENT_PARTY_SIGNED,
DOCUMENT_PARTY_REJECTED,
DOCUMENT_PARTY_DELEGATED,
DOCUMENT_PARTY_AUTH_FAILED,
DOCUMENT_PARTY_ADDED,
DOCUMENT_PARTY_REMOVED,
DOCUMENT_REMINDER_AUTOMATIC,
DOCUMENT_REMINDER_MANUAL,
DOCUMENT_ARCHIVE_UPLOADED,
ID_CREATED,
ID_SENT,
ID_OPENED,
ID_VERIFIED,
ID_FAILED,
ID_CANCELED,
CONTACT_CREATED,
CONTACT_UPDATED,
CONTACT_DELETED,
TEMPLATE_CREATED,
TEMPLATE_UPDATED,
TEMPLATE_DELETED,
TEMPLATE_RESTORED,
FORM_SUBMITTED,
WORKSPACE_CREATED,
MEMBER_ADDED,
LOGIN_COMPLETED,
LOGIN_FAILED,
SECURITY_DOCUMENT_DOWNLOADED,
SECURITY_DOCUMENTS_EXPORTED,
SECURITY_SIGNATURE_IDENTITY_ACCESSED,
SECURITY_WORKSPACE_MEMBER_REMOVED,
SECURITY_WORKSPACE_MEMBER_ROLE_CHANGED,
SECURITY_WORKSPACE_ROLE_UPDATED,
SECURITY_WORKSPACE_RETENTION_UPDATED
enabled
boolean
default:true
required

Whether this webhook is active (default: true)

secret
string | null

Signing key for this endpoint. A 32-byte key is generated when omitted; deliveries are signed with it in X-Sajn-Signature

failureNotificationEmail
string<email> | null

Email address that will be notified if webhook delivery fails

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Response

Webhook response

Webhook response

id
string
required

Unique webhook identifier

webhookUrl
string
required

URL that receives webhook events

secret
string | null
required

Signing key for this endpoint. Deliveries carry X-Sajn-Signature: t=,v1=<hex hmac-sha256 over ".">

enabled
boolean
required

Whether this webhook is active

failureNotificationEmail
string | null
required

Email address that receives a notification if webhook delivery fails

eventTriggers
string[]
required

List of event types this webhook subscribes to

createdAt
string<date-time>
required

Date and time when webhook was created

updatedAt
string<date-time>
required

Date and time when webhook was last updated