SIsignnow

Get callback info by ID

This endpoint allows API users to get detailed info about one webhook by its ID.

get/v2/event-subscriptions/{subscription_id}/callbacks/{callback_id}

Request

Path parameters

ID of the webhook.

ID of the subscription.

Response

Depending on the type of event, the initiator_id parameter can be placed differently in response body (into the request_content object):

  • only in the meta object if event_name is:

    • document.update
    • document.complete
    • document.open
    • template.copy
    • document.fieldinvite.create etc.
    • document_group.update
    • document_group.invite.create etc.;

  • in the meta and in the content objects if event_name is:

    • document.delete
    • document_group.delete
    • document_group.open
    • user.document_group.open
    • document_group.invite.declined
    • user.document_group.invite.declined
    • document_group.complete
    • user.document_group.complete

The type of event also affects the composition of the parameters of the request_content object.

<details> <summary>See the callback payload for each event</summary> <br> <table> <tr> <td> Event </td> <td> "request_content" object </td> </tr> <tr> <td> <code>document.delete</code> <br> <code>user.document.delete</code> </td> <td> 

{
   "meta": {
      "timestamp": 1748521868,
      "event": "document.delete",
      "environment": "https://api.signnow.com",
      "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423",
      "callback_url": "https://example.com/webhook?Param={\"docId\":\"f700eef0e3de55b12cef7cbfba2e036f336b245a\"}",
      "access_token": "********",
      "metadata": []
   },
   "content": {
      "document_id": "f700eef0e3de55b12cef7cbfba2e036f336b245a",
      "document_name": "Sample Document",
      "user_id": "b2e8364f412c04037bee10a8db9201a727551443",
      "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423",
      "initiator_email": "signer@example.com"
   }
}
</td> </tr> <tr> <td> <code>document.update</code> <br> <code>user.document.update</code> <br> <code>user.document.create</code> <br> <code>user.document.complete</code> <br> <code>document.complete</code> </td> <td> 

{
   "meta": {
      "timestamp": 1748521868,
      "event": "document.update",
      "environment": "https://api.signnow.com",
      "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423",
      "callback_url": "https://example.com/webhook?Param={\"docId\":\"f700eef0e3de55b12cef7cbfba2e036f336b245a\"}",
      "access_token": "********",
      "metadata": []
   },
   "content": {
      "document_id": "f700eef0e3de55b12cef7cbfba2e036f336b245a",
      "document_name": "Sample Document",
      "user_id": "b2e8364f412c04037bee10a8db9201a727551443"
   }
}
</td> </tr> <tr> <td> <code>document.open</code> <br> <code>user.document.open</code> </td> <td> 

{
   "meta": {
      "timestamp": 1748521868,
      "event": "document.open",
      "environment": "https://api.signnow.com",
      "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423",
      "callback_url": "https://example.com/webhook?Param={\"docId\":\"f700eef0e3de55b12cef7cbfba2e036f336b245a\"}",
      "access_token": "********",
      "metadata": []
   },
   "content": {
      "document_id": "f700eef0e3de55b12cef7cbfba2e036f336b245a",
      "document_name": "Sample Document",
      "user_id": "b2e8364f412c04037bee10a8db9201a727551443",
      "viewer_user_unique_id": "12b5d12203a916fa07f5b13c362140efebdbce5f"
   }
}
</td> </tr> <tr> <td> <code>template.copy</code> <br> <code>user.template.copy</code> </td> <td> 

{
   "meta": {
      "timestamp": 1748521868,
      "event": "template.copy",
      "environment": "https://api.signnow.com",
      "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423",
      "callback_url": "https://example.com/webhook?Param={\"docId\":\"f700eef0e3de55b12cef7cbfba2e036f336b245a\"}",
      "access_token": "********",
      "metadata": []
   },
   "content": {
      "document_id": "f700eef0e3de55b12cef7cbfba2e036f336b245a",
      "template_id": "c70050bfdf4c4d8187783deaac304cb7cbe450b5",
      "user_id": "b2e8364f412c04037bee10a8db9201a727551443",
      "viewer_user_unique_id": "12b5d12203a916fa07f5b13c362140efebdbce5f"
   }
}
</td> </tr> <tr> <td> <code>user.document.fieldinvite.create</code> <br> <code>user.document.fieldinvite.decline</code> <br> <code>user.document.fieldinvite.delete</code> <br> <code>user.document.fieldinvite.signed</code> <br> <code>user.document.fieldinvite.sent</code> <br> <code>user.document.freeform.create</code> <br> <code>user.document.freeform.signed</code> <br> <code>document.fieldinvite.create</code> <br> <code>document.fieldinvite.decline</code> <br> <code>document.fieldinvite.delete</code> <br> <code>document.fieldinvite.signed</code> <br> <code>document.fieldinvite.sent</code> <br> <code>document.freeform.create</code> <br> <code>document.freeform.signed</code> </td> <td> 

{
   "meta": {
      "timestamp": 1748521868,
      "event": "document.fieldinvite.create",
      "environment": "https://api.signnow.com",
      "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423",
      "callback_url": "https://example.com/webhook?Param={\"docId\":\"f700eef0e3de55b12cef7cbfba2e036f336b245a\"}",
      "access_token": "********",
      "metadata": []
   },
   "content": {
      "document_id": "f700eef0e3de55b12cef7cbfba2e036f336b245a",
      "invite_id": "e575c611b641ea7694c6fa3acf3b2fa6dba14287",
      "signer": "signer@example.com",
      "status": "pending"
   }
}
</td> </tr> <tr> <td> <code>user.document.fieldinvite.reassign</code> <br> <code>document.fieldinvite.reassign</code> </td> <td> 

{
   "meta": {
      "timestamp": 1748521868,
      "event": "document.fieldinvite.reassign",
      "environment": "https://api.signnow.com",
      "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423",
      "callback_url": "https://example.com/webhook?Param={\"docId\":\"f700eef0e3de55b12cef7cbfba2e036f336b245a\"}",
      "access_token": "********",
      "metadata": []
   },
   "content": {
      "document_id": "f700eef0e3de55b12cef7cbfba2e036f336b245a",
      "invite_id": "e575c611b641ea7694c6fa3acf3b2fa6dba14287",
      "signer": "signer@example.com",
      "old_invite_unique_id": "a3c84d21c3631347f854510d6facb30129f9bc06"
   }
}
</td> </tr> <tr> <td> <code>user.document.fieldinvite.replace</code> <br> <code>document.fieldinvite.replace</code> </td> <td> 

{
   "meta": {
      "timestamp": 1748521868,
      "event": "document.fieldinvite.replace",
      "environment": "https://api.signnow.com",
      "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423",
      "callback_url": "https://example.com/webhook?Param={\"docId\":\"f700eef0e3de55b12cef7cbfba2e036f336b245a\"}",
      "access_token": "********",
      "metadata": []
   },
   "content": {
      "document_id": "f700eef0e3de55b12cef7cbfba2e036f336b245a",
      "invite_id": "e575c611b641ea7694c6fa3acf3b2fa6dba14287",
      "signer": "signer@example.com",
      "old_invite_unique_id": "a3c84d21c3631347f854510d6facb30129f9bc06",
      "group_invite": true
   }
}
</td> </tr> <tr> <td> <code>user.document_group.create</code> <br> <code>user.document_group.update</code> <br> <code>document_group.update</code> </td> <td> 

{
   "meta": {
      "timestamp": 1748521868,
      "event": "document_group.update",
      "environment": "https://api.signnow.com",
      "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423",
      "callback_url": "https://example.com/webhook?Param={\"groupId\":\"a1658c1b66afcc757aff9859095927ecb3a55cd3\"}",
      "access_token": "********",
      "metadata": []
   },
   "content": {
      "group_id": "a1658c1b66afcc757aff9859095927ecb3a55cd3",
      "group_name": "Sample Document Group",
      "user_id": "b2e8364f412c04037bee10a8db9201a727551443"
   }
}
</td> </tr> <tr> <td> <code>user.document_group.complete</code> <br> <code>document_group.complete</code> </td> <td> 

{
   "meta": {
      "timestamp": 1748521868,
      "event": "document_group.complete",
      "environment": "https://api.signnow.com",
      "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423",
      "callback_url": "https://example.com/webhook?Param={\"groupId\":\"a1658c1b66afcc757aff9859095927ecb3a55cd3\"}",
      "access_token": "********",
      "metadata": []
   },
   "content": {
      "group_id": "a1658c1b66afcc757aff9859095927ecb3a55cd3",
      "group_name": "Sample Document Group",
      "user_id": "b2e8364f412c04037bee10a8db9201a727551443",
      "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423",
      "initiator_email": "signer@example.com",
      "completed_at": 1748521868,
      "documents": [
         {
            "document_id": "f700eef0e3de55b12cef7cbfba2e036f336b245a",
            "document_name": "Sample Document",
            "status": "completed"
         }
      ],
      "invite_steps": [
         {
            "order": 1,
            "status": "completed",
            "signers": [
               {
                  "email": "signer@example.com",
                  "role_name": "Signer 1",
                  "action": "sign",
                  "status": "fulfilled",
                  "document_id": "f700eef0e3de55b12cef7cbfba2e036f336b245a",
                  "signed_at": 1748521800
               }
            ]
         }
      ]
   }
}
</td> </tr> <tr> <td> <code>document_group.delete</code> <br> <code>user.document_group.delete</code> </td> <td> 

{
   "meta": {
      "timestamp": 1748521868,
      "event": "document_group.delete",
      "environment": "https://api.signnow.com",
      "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423",
      "callback_url": "https://example.com/webhook?Param={\"groupId\":\"a1658c1b66afcc757aff9859095927ecb3a55cd3\"}",
      "access_token": "********",
      "metadata": []
   },
   "content": {
      "group_id": "a1658c1b66afcc757aff9859095927ecb3a55cd3",
      "group_name": "Sample Document Group",
      "user_id": "b2e8364f412c04037bee10a8db9201a727551443",
      "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423",
      "initiator_email": "signer@example.com"
   }
}
</td> </tr> <tr> <td> <code>document_group.open</code> <br> <code>user.document_group.open</code> </td> <td> 

{
   "meta": {
      "timestamp": 1748521868,
      "event": "document_group.open",
      "environment": "https://api.signnow.com",
      "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423",
      "callback_url": "https://example.com/webhook?Param={\"groupId\":\"a1658c1b66afcc757aff9859095927ecb3a55cd3\"}",
      "access_token": "********",
      "metadata": []
   },
   "content": {
      "group_id": "a1658c1b66afcc757aff9859095927ecb3a55cd3",
      "group_name": "Sample Document Group",
      "user_id": "b2e8364f412c04037bee10a8db9201a727551443",
      "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423",
      "initiator_email": "signer@example.com"
   }
}
</td> </tr> <tr> <td> <code>user.document_group.invite.create</code> <br> <code>user.document_group.invite.resend</code> <br> <code>user.document_group.invite.update</code> <br> <code>user.document_group.invite.cancel</code> <br> <code>document_group.invite.create</code> <br> <code>document_group.invite.resend</code> <br> <code>document_group.invite.update</code> <br> <code>document_group.invite.cancel</code> </td> <td> 

{
   "meta": {
      "timestamp": 1748521868,
      "event": "document_group.invite.create",
      "environment": "https://api.signnow.com",
      "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423",
      "callback_url": "https://example.com/webhook?Param={\"groupId\":\"a1658c1b66afcc757aff9859095927ecb3a55cd3\"}",
      "access_token": "********",
      "metadata": []
   },
   "content": {
      "group_id": "a1658c1b66afcc757aff9859095927ecb3a55cd3",
      "group_invite_id": "d4d02074b369b58f303aebc46680b161419072d1",
      "status": "pending"
   }
}
</td> </tr> <tr> <td> <code>document_group.invite.declined</code> <br> <code>user.document_group.invite.declined</code> </td> <td> 

{
   "meta": {
      "timestamp": 1748521868,
      "event": "document_group.invite.declined",
      "environment": "https://api.signnow.com",
      "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423",
      "callback_url": "https://example.com/webhook?Param={\"groupId\":\"a1658c1b66afcc757aff9859095927ecb3a55cd3\"}",
      "access_token": "********",
      "metadata": []
   },
   "content": {
      "group_id": "a1658c1b66afcc757aff9859095927ecb3a55cd3",
      "group_invite_id": "d4d02074b369b58f303aebc46680b161419072d1",
      "status": "canceled",
      "initiator_id": "c3150254674a3129b28dd20e4049baacec3dc423",
      "initiator_email": "signer@example.com"
   }
}

Note: For SMS invitees, initiator_email contains a system-generated address in the format sms_signer_{phone_number}@no.reply.

</td> </tr> <tr> <td> <code>user.document_group.invite.expired</code> </td> <td> 

{
   "meta": {
      "timestamp": 1748521868,
      "event": "user.document_group.invite.expired",
      "environment": "https://api.signnow.com",
      "initiator_id": null,
      "callback_url": "https://example.com/webhook?Param={\"groupId\":\"a1658c1b66afcc757aff9859095927ecb3a55cd3\"}",
      "access_token": "********",
      "metadata": []
   },
   "content": {
      "group_id": "a1658c1b66afcc757aff9859095927ecb3a55cd3",
      "group_name": "Sample Document Group",
      "group_invite_id": "d4d02074b369b58f303aebc46680b161419072d1",
      "step": 2,
      "signers": [
         "signer@example.com",
         "signer2@example.com"
      ]
   }
}
</td> </tr> </table> </details> <br>

Param will be added to callback_url parameter, if docid_queryparam is true:

"callback_url":"{{callback_url}}?Param={\"groupId\":\"{{document_unique_id}}\"}

See docid_queryparam details

access_token will be added only if delete_access_token will be false.

<br>

See delete_access_token details.

Changes

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