About SSE notifications service

Use the SSE notifications service to maintain a continuous channel for Signer envelope status updates.

CAUTION:

This is a limited service. It is available only after approval from the Sovos team.

The SSE notifications service is an alternative channel to Signer webhooks for customers to receive event notifications related to signed envelopes. This service allows the customer to initiate the communication and keep an open channel to receive notifications.

Note: Currently, notifications are sent for completed, canceled, or processed envelope events as soon as the signing process is finished.

Authentication

You can reuse the same access token that you obtained for the standard Signer authentication flow to authenticate requests to the SSE notifications service.

Enabling the service

Send a GET request to the /events/v1/subscribe endpoint, including the "Accept: text/event-stream" and "Authorization: Bearer [token]" headers.

GET {add url}/events/v1/subscribe
--header "Accept: text/event-stream"
--header "Authorization: Bearer [token]"

When you enable the service, you receive notifications for all envelopes associated with your account, without needing to subscribe to each envelope individually.

This service is best suited for backend integrations that maintain the SSE connection, map events, and process notifications to extract key data, such as document download URLs. Use the envelope ID received in the notification to retrieve detailed envelope information through the Signer APIs.

The audit trail link is valid for 24 hours. After subscribing to the service, you can use the audit trail information to retrieve envelope details through the Signer APIs and asynchronously notify consuming systems for processing the new events.

Important: Using the SSE notifications service, the client must keep the connection open and listen for events. If the client is not connected at the time an event occurs, the notification is lost.

Notifications sample

{"result":{"message":{"@type":"type.googleapis.com/scs.notifications.v1alpha1.NotificationMessage","initiative":"b0a09235-b87a-4a06-a9ff-bb0b51855ebe","envelopeId":"4a1ec389-fceb-429a-a248-b4ea7bba9ecf","status":"COMPLETED","reason":"","documentFiles":["http://host.docker.internal:9000/ssa-storage/b0a09235-b87a-4a06-a9ff-bb0b51855ebe/sovossigner/4a1ec389-fceb-429a-a248-b4ea7bba9ecf/mi%20documento.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256\u0026X-Amz-Date=20260512T160803Z\u0026X-Amz-SignedHeaders=host\u0026X-Amz-Expires=86400\u0026X-Amz-Credential=minioadmin%2F20260512%2Fus-east-1%2Fs3%2Faws4_request\u0026X-Amz-Signature=d8c914db7e049ec85d334511adda57aa0ae4b091c3728e2ff9f3705f4df367da","http://host.docker.internal:9000/ssa-storage/b0a09235-b87a-4a06-a9ff-bb0b51855ebe/sovossigner/4a1ec389-fceb-429a-a248-b4ea7bba9ecf/mi%20documento%202.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256\u0026X-Amz-Date=20260512T160803Z\u0026X-Amz-SignedHeaders=host\u0026X-Amz-Expires=86400\u0026X-Amz-Credential=minioadmin%2F20260512%2Fus-east-1%2Fs3%2Faws4_request\u0026X-Amz-Signature=f40bfe83ff7e9199b6dad334337c93ae48b5e5ac73f299b67f565efb9c2fc8ee"],"generatedFiles":["http://host.docker.internal:9000/ssa-storage/b0a09235-b87a-4a06-a9ff-bb0b51855ebe/sovossigner/4a1ec389-fceb-429a-a248-b4ea7bba9ecf/audit_sheet.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256\u0026X-Amz-Date=20260512T160803Z\u0026X-Amz-SignedHeaders=host\u0026X-Amz-Expires=86400\u0026X-Amz-Credential=minioadmin%2F20260512%2Fus-east-1%2Fs3%2Faws4_request\u0026X-Amz-Signature=09b0d1e5c588b5ad304d144b6310694bc9d2eb56542e3fe14029fb0b0c1ffe27"]}}}

Sovos Docs

About SSE notifications service

Authentication

Enabling the service

Notifications sample

sovos-footer