Event subscriptions

In Webhooks 2.0 signNow API introduces entities to set up the scope of events available for callbacks. The two entities you can now use are document and user. To set up the scope, {entity_id} is required for every event subscription.

At document scope, you receive callbacks after events involving a specific document. The {entity_id} == document_id in this case.

When you specify document_id, you receive callbacks when this document is signed. If it was sent to three signers, you receive one callback after the last signature.

See the Types of events for the query and callback payloads.

curl -L -X POST 'https://api.signnow.com//api/v2/events' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {{access_token}}' \
--data-raw '{
  "event": "user.document.complete",
  "entity_id": "890d13607d89a7b3f6e67a14757d02ec00cf5eae",
  "action": "callback",
  "attributes": {
    "callback": "http://my-site.com",
    "use_tls_12": true,
    "docid_queryparam": true,
    "headers": {
      "string_head": "test",
      "int_head": 12,
      "bool_head": false,
      "float_head": 12.24
    }
  }
}'

At user scope , you receive callbacks after events involving a specific user. The {entity_id} == user_id in this case.

When you specify user_id and subscribe to user.document.complete, you receive callbacks after every signing of this user’s documents. In callbacks you receive the document_id that specifies which document was signed.

curl -X POST \
  https://api.signnow.com/api/v2/events \
  -H 'Authorization =  Bearer {{access_token}}' \
  -H 'Content-Type = application/json' \
  -d '{
  "event": "user.document.complete",
  "user_id": "i3j4j0j38jccislfm04ijidcs7770sdjk2ooko4390dksjn",
  "action": "callback",
  "attributes": {
    "callback": "https://my.integration.com ",
    "use_tls_12": true,
    "integration_id": "Unique ID Integration System",
    "docid_queryparam": true,
    "headers": {
      "string_head": "test",
      "int_head": 12,
      "bool_head": false,
      "float_head": 12.24
    }
  }
}'

Retries [currently available only in Production environment]

signNow event processor marks callback task as 'success' when it gets 2xx HTTP response.

Service makes 10 more attempts to deliver a callback when callback returns 5xx HTTP response. Up to 5 retries are sent one by one immediately after getting 5xx response and then 5 more are sent - one every 4 hours.

Service marks callback task as 'failed' when it returns 5xx after all 5 retries.

Service marks callback task as 'failed' when callback returns 4xx HTTP response.

Callback subscription will be deactivated when callback returns 4xx 10 times in a row within one month.