Create event subscription

This endpoint allows API users to subscribe an external service (callback_url) to a specific event related to a user, document, or document group. When the subscribed event occurs, your service receives a notification.

See the full list of available events in the Webhooks user guide. Use HMAC verification for an additional layer of security.

[!NOTE] For the payload your service receives for each event, see the response examples in Get callback info by ID.

post/v2/event-subscriptions

Request

Base URL
https://api.signnow.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/signnow/apis/signnow-api/docs/v2/event-subscriptions/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

eventstring required

Event name that triggers the subscription. Check list of events.

entity_idstring required

Unique string ID of the entity (e.g., document_id, user_id, document_group_id).

Example request

{
  "event": "document.open",
  "entity_id": "a1b2c3d4e5f67890123456789abcdef012345678",
  "attributes": {
    "callback": "https://webhook.site/a0093533-766c-456e-b625-97592745216a",
    "secret_key": "c8XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  }
}

Response

Event subscription created.

Changes

No recorded changes to this operation across all 1 revision of this API.