Skip to Content

Webhook events

Every webhook event that sajn sends, when it fires, and the data it carries

Subscribe an endpoint to an event by adding its type to the webhook's events. Event types are dotted lowercase names: the resource, an optional sub-resource, and what happened, such as document.party.signed. This page lists every type, grouped by resource. Each event links to its reference page, which has the full schema, and each group links to its data on Webhook payloads.

Every event appears in GET /api/v1/events for 30 days, whether or not an endpoint subscribed to it. sajn records each occurrence once: if the same thing is reported again with identical data, such as a party opening a document a second time before anything changed, sajn neither records nor delivers it again.

Choose events

Most integrations need only a few events:

ToSubscribe to
Store the signed PDFdocument.completed
Mirror document status in a CRMdocument.sent, document.completed, document.rejected, document.expired, document.withdrawn
Track each party's progressdocument.party.opened, document.party.signed, document.party.rejected
Catch invitations that didn't arrivedocument.party.delivery_failed
Chase documents before they expiredocument.expiring_soon
Follow internal approvalsThe approval_request.* events
Act on a submitted formform.submitted
Warn before work stops on a quotausage.limit_reached
Feed a SIEMThe security.* events

document.completed means that the sealed PDF is ready: sajn fires it after it has sealed the signed document. document.fully_signed fires earlier, when every party has signed but before the seal, so don't download the signed file on it.

Document events

These events fire when a document changes state. data.object is the document, in the shape that GET /api/v1/documents/{id} returns. For the extra fields, see Document events.

EventFires when
document.createdA document is created, including as a duplicate of another document or from an attachment emailed to the workspace inbox. data.source says which.
document.sentThe document is sent to its parties. Sending it again after a withdrawal fires the event again.
document.fully_signedEvery party has signed. sajn hasn't sealed the PDF yet.
document.completedsajn has sealed the signed PDF, and the document is complete.
document.rejectedA party rejects the document, which ends signing for every party. document.party.rejected reports the same rejection with the party.
document.expiredA pending document passes its expiration date before every party has signed.
document.expiring_soonA pending document expires in about a day, and at least one party hasn't signed.
document.expiration_extendedA pending or expired document gets a new expiration date. An expired document returns to PENDING. data.previousAttributes.expiresAt holds the earlier date.
document.withdrawnThe sender withdraws a sent document. The document returns to DRAFT.
document.updatedThe content of a sent document is updated in place, before anyone has signed.
document.deletedThe document moves to the trash, by a member or by the workspace's retention policy.
document.restoredThe document is restored from the trash.
document.archivedThe document is archived.
document.unarchivedThe document is taken out of the archive.
document.comment.createdA workspace member or a party comments on the document, in a new thread or as a reply. data.object is the comment, and data.thread is its thread.

Party events

These events fire when something happens to one party on a document. data.object is the document, and data.party is the party that the event is about, as GET /api/v1/documents/{id}/parties lists it. For the extra fields, see Party events.

EventFires when
document.party.sentsajn sends the party their invitation by email or SMS.
document.party.delivery_failedThe party's invitation email bounces or their SMS fails. After a bounce, sajn also stops the party's scheduled reminders.
document.party.openedThe party opens the document from the signing link. It can fire again on a later visit.
document.party.readThe party has read the whole document in the signing view. It fires once per party.
document.party.verifiedThe party passes the verification that protects the document, such as an SMS code, a PIN, or an eID. data.purpose is ACCESS or SIGN.
document.party.auth_failedThe party fails a verification step, such as a wrong SMS code or PIN, or a failed eID authentication.
document.party.signedThe party signs.
document.party.rejectedThe party rejects the document.
document.party.delegatedThe party delegates signing to someone else. data.delegation describes the delegate.
document.party.updatedSomeone corrects the name, email address, or phone number of a party who hasn't signed a sent document. data.previousAttributes holds the old values.
document.party.addedA party is added to a document that's already sent.
document.party.removedA party is removed from a document that's already sent. data.party is the party as it was, and data.object.parties no longer lists it.
document.party.remindedThe party gets a reminder to sign. data.trigger is AUTOMATIC for a scheduled reminder, or MANUAL for one that someone sent.

Approval request events

These events follow a document's internal approval. data.object is the approval request, as GET /api/v1/approval-requests/{id} returns it.

EventFires when
approval_request.createdA document is submitted for approval, from the dashboard or the API. A rejected request that's submitted again fires it again, with the same id.
approval_request.approvedThe last required approver approves. If autoSend is true, sajn then sends the document, which fires document.sent.
approval_request.rejectedAn approver rejects the request. The document returns to DRAFT.
approval_request.cancelledThe requester cancels a pending request. sajn deletes the request, and the document returns to DRAFT.

Identity check events

These events fire as an identity check moves through its steps. data.object is the check, as GET /api/v1/identity-checks lists it. The data never contains the verified national identity number.

EventFires when
identity_check.createdAn identity check is created.
identity_check.sentsajn sends the verification link by email or SMS, including when it's sent again.
identity_check.openedThe person opens the verification link.
identity_check.verifiedThe person completes the verification.
identity_check.failedThe verification fails. data.failureReason says why.
identity_check.cancelledThe identity check is cancelled.

Contact and company events

These events fire when a contact or a company in the workspace changes. data.object is the contact, as GET /api/v1/contacts/{id} returns it, or the company, as GET /api/v1/companies/{id} returns it.

EventFires when
contact.createdA contact is created.
contact.updatedA contact's details change.
contact.deletedA contact is deleted. data.object is the contact as it was.
company.createdA company is created, including when sajn creates one for a new contact's company name.
company.updatedA company's name, organization number, or country changes.
company.deletedA company is deleted.

Template and form events

Template events fire when a template changes; forms don't fire them. data.object is the template, as GET /api/v1/templates/{id} returns it.

EventFires when
template.createdA template is created, including as a duplicate of another template.
template.updatedA template changes. sajn sends at most one event per template per minute, and data.previousAttributes holds the earlier values of what changed. Treat it as a signal to read the template again, not as a complete change log.
template.deletedA template moves to the trash.
template.restoredA template is restored from the trash.
form.submittedA respondent submits a public form. It fires once per submission. data.object is the submission, as GET /api/v1/forms/{id}/submissions/{submissionId} returns it.

Workspace and usage events

EventFires when
workspace.createdA workspace is created. The event belongs to the new workspace, so an endpoint in another workspace doesn't receive it.
member.invitedsajn sends someone an invitation to join the workspace. It fires once per invitation. data.object is the invitation, as GET /api/v1/member-invites lists it.
member.invite_acceptedThe invitee accepts the invitation. member.added fires too, with the new member.
member.addedA user joins the workspace. data.object is the member, as GET /api/v1/members/{userId} returns it, and data.via says how they joined.
usage.limit_reachedThe organization reaches its monthly document quota or an eID signature quota. It fires at most once per quota and billing period. Signatures beyond the quota are billed from the balance; documents beyond it are refused until the period ends or the plan changes.

Security events

These events report security-relevant actions in a workspace, for a SIEM or an audit feed. data.object holds the details, and actor says whether a user, an API key, or an OAuth app acted. For the fields, see Security events.

EventFires when
security.document_downloadedSomeone downloads a document's original file, signed file, or audit journal.
security.documents_exportedSomeone exports documents in bulk, from a selection or a folder.
security.signature_identity_accessedSomeone reads the signatures and identity data of a document.
security.member_removedA member is removed from the workspace.
security.member_role_changedA workspace member gets a different role.
security.role_updatedA workspace role's definition is saved, through the dashboard or the API.
security.workspace_retention_updatedThe workspace's retention periods change.

Organization-level actions, such as sign-ins, two-factor changes, and API key changes, have no security event, because webhooks belong to a workspace.

sajn Login events

login.completed and login.failed report the outcome of a sajn Login authentication. They use the same delivery, signing, and retries as every other event. For when they fire and their data, see Login webhooks.

Test event

webhook.test is sent only when you call POST /api/v1/webhooks/{id}/test, and only to that webhook. You can't subscribe to it, and GET /api/v1/events doesn't list it. data.object is the webhook's id and url. For how to use it, see Test webhooks locally.

Events in API version 2026-09

An endpoint on 2026-09 receives the same events under their uppercase names, such as DOCUMENT_PARTY_SIGNED. A few differ: document.fully_signed is DOCUMENT_SIGNED, an inbox upload also fires DOCUMENT_ARCHIVE_UPLOADED, reminders are DOCUMENT_REMINDER_AUTOMATIC and DOCUMENT_REMINDER_MANUAL, identity check events are ID_* with ID_CANCELED, and security events are SECURITY_*. For the full mapping, see Upgrading to 2026-10.

Was this page helpful?

Last updated on