Migrating Webhooks
The signature of data sent to Webhooks although remains predominantly the same except the change in file ids to be an array to support envelope requests which contain more than 1 document.
Additionally v2 supports adding a secure token in the metadata to the endpoint helping secure the calls from Signeasy servers to your endpoints.
document.signed
The format of this call remains the same as before.
rs.initiated
{
"data":{
"aadhaar_enabled": null,
"created_time": 1557465368,
"has_markers": 0,
"id": 235649,
"is_in_person": 0,
"is_ordered": 1,
"last_modified_time": 1557465371,
"logo": null,
"name": "Offer letter - Prashanth.pdf",
"next": 377928,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "Sunil",
"owner_last_name": "Patro EK",
"owner_user_id": 3625900,
"recipients": [
{
"created_time": 1557465369,
"email": "[email protected]",
"first_name": "Prashanth",
"last_modified_time": 1591780421,
"last_name": "Raghu",
"order_id": 1,
"recipient_id": 377928,
"recipient_user_id": 3625901,
"status": "viewed"
}
],
"status": "incomplete"
},
"metadata":{
"event_type":"rs.initiated",
"event_user_id":1,
"client_id":"6xkfd7cC9TEcXPOy1jxbHg9k8O8IpmQRAt7AWrTm",
"event_user":"[email protected]"
}
}
{
"data":{
"aadhaar_enabled": null,
"created_time": 1557465368,
"has_markers": 0,
"id": 235649,
"is_in_person": 0,
"is_ordered": 1,
"last_modified_time": 1557465371,
"logo": null,
"name": "Offer letter - Prashanth.pdf",
"next": 377928,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "Sunil",
"owner_last_name": "Patro EK",
"owner_user_id": 3625900,
"sources": [
{
"id": 223221,
"name": "Offer letter",
"type": "original"
}
],
"recipients": [
{
"created_time": 1557465369,
"email": "[email protected]",
"first_name": "Prashanth",
"last_modified_time": 1591780421,
"last_name": "Raghu",
"order_id": 1,
"recipient_id": 377928,
"recipient_user_id": 3625901,
"status": "viewed"
}
],
"status": "incomplete"
},
"metadata":{
"token": "myloooooooongtokenbiggerthan12chars",
"event_type":"rs.initiated",
"event_user_id":1,
"client_id":"6xkfd7cC9TEcXPOy1jxbHg9k8O8IpmQRAt7AWrTm",
"event_user":"[email protected]"
}
}
rs.link_sent
{
"data":{
"aadhaar_enabled": null,
"created_time": 1557465368,
"has_markers": 0,
"id": 235649,
"is_in_person": 0,
"is_ordered": 1,
"last_modified_time": 1557465371,
"logo": null,
"name": "Offer letter - Prashanth.pdf",
"next": 377928,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "Sunil",
"owner_last_name": "Patro EK",
"owner_user_id": 3625900,
"recipients": [
{
"created_time": 1557465369,
"email": "[email protected]",
"first_name": "Prashanth",
"last_modified_time": 1591780421,
"last_name": "Raghu",
"order_id": 1,
"recipient_id": 377928,
"recipient_user_id": 3625901,
"status": "viewed"
}
],
"status": "incomplete"
},
"metadata":{
"event_type":"rs.link_sent",
"event_user_id":1,
"client_id":"6xkfd7cC9TEcXPOy1jxbHg9k8O8IpmQRAt7AWrTm",
"event_user":"[email protected]"
}
}
{
"data":{
"aadhaar_enabled": null,
"created_time": 1557465368,
"has_markers": 0,
"id": 235649,
"is_in_person": 0,
"is_ordered": 1,
"last_modified_time": 1557465371,
"logo": null,
"name": "Offer letter - Prashanth.pdf",
"next": 377928,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "Sunil",
"owner_last_name": "Patro EK",
"owner_user_id": 3625900,
"sources": [
{
"id": 223221,
"name": "Offer letter",
"type": "original"
}
],
"recipients": [
{
"created_time": 1557465369,
"email": "[email protected]",
"first_name": "Prashanth",
"last_modified_time": 1591780421,
"last_name": "Raghu",
"order_id": 1,
"recipient_id": 377928,
"recipient_user_id": 3625901,
"status": "viewed"
}
],
"status": "incomplete"
},
"metadata":{
"token": "myloooooooongtokenbiggerthan12chars",
"event_type":"rs.link_sent",
"event_user_id":1,
"client_id":"6xkfd7cC9TEcXPOy1jxbHg9k8O8IpmQRAt7AWrTm",
"event_user":"[email protected]"
}
}
rs.viewed
{
"data":{
"aadhaar_enabled": null,
"created_time": 1557465368,
"has_markers": 0,
"id": 235649,
"is_in_person": 0,
"is_ordered": 1,
"last_modified_time": 1557465371,
"logo": null,
"name": "Offer letter - Prashanth.pdf",
"next": 377928,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "Sunil",
"owner_last_name": "Patro EK",
"owner_user_id": 3625900,
"recipients": [
{
"created_time": 1557465369,
"email": "[email protected]",
"first_name": "Prashanth",
"last_modified_time": 1591780421,
"last_name": "Raghu",
"order_id": 1,
"recipient_id": 377928,
"recipient_user_id": 3625901,
"status": "viewed"
}
],
"status": "incomplete"
},
"metadata":{
"event_type":"rs.viewed",
"event_user_id": 1,
"client_id":"6xkfd7cC9TEcXPOy1jxbHg9k8O8IpmQRAt7AWrTm",
"event_user":"[email protected]"
}
}
{
"data":{
"aadhaar_enabled": null,
"created_time": 1557465368,
"has_markers": 0,
"id": 235649,
"is_in_person": 0,
"is_ordered": 1,
"last_modified_time": 1557465371,
"logo": null,
"name": "Offer letter - Prashanth.pdf",
"next": 377928,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "Sunil",
"owner_last_name": "Patro EK",
"owner_user_id": 3625900,
"sources": [
{
"id": 223221,
"name": "Offer letter",
"type": "original"
}
],
"recipients": [
{
"created_time": 1557465369,
"email": "[email protected]",
"first_name": "Prashanth",
"last_modified_time": 1591780421,
"last_name": "Raghu",
"order_id": 1,
"recipient_id": 377928,
"recipient_user_id": 3625901,
"status": "viewed"
}
],
"status": "incomplete"
},
"metadata": {
"token": "myloooooooongtokenbiggerthan12chars",
"event_type":"rs.viewed",
"event_user_id":1,
"client_id":"6xkfd7cC9TEcXPOy1jxbHg9k8O8IpmQRAt7AWrTm",
"event_user":"[email protected]"
}
}
rs.signed
{
"data":{
"aadhaar_enabled": null,
"created_time": 1557465368,
"has_markers": 0,
"id": 235649,
"is_in_person": 0,
"is_ordered": 1,
"last_modified_time": 1557465371,
"logo": null,
"name": "Offer letter - Prashanth.pdf",
"next": 377928,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "Sunil",
"owner_last_name": "Patro EK",
"owner_user_id": 3625900,
"recipients": [
{
"created_time": 1557465369,
"email": "[email protected]",
"first_name": "Prashanth",
"last_modified_time": 1591780421,
"last_name": "Raghu",
"order_id": 1,
"recipient_id": 377928,
"recipient_user_id": 3625901,
"status": "complete"
}
],
"status": "complete"
},
"metadata":{
"event_type":"rs.signed",
"event_user_id": 1,
"client_id":"6xkfd7cC9TEcXPOy1jxbHg9k8O8IpmQRAt7AWrTm",
"event_user":"[email protected]"
}
}
{
"data":{
"aadhaar_enabled": null,
"created_time": 1557465368,
"has_markers": 0,
"id": 235649,
"is_in_person": 0,
"is_ordered": 1,
"last_modified_time": 1557465371,
"logo": null,
"name": "Offer letter - Prashanth.pdf",
"next": 377928,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "Sunil",
"owner_last_name": "Patro EK",
"owner_user_id": 3625900,
"sources": [
{
"id": 223221,
"name": "Offer letter",
"type": "original"
}
],
"recipients": [
{
"created_time": 1557465369,
"email": "[email protected]",
"first_name": "Prashanth",
"last_modified_time": 1591780421,
"last_name": "Raghu",
"order_id": 1,
"recipient_id": 377928,
"recipient_user_id": 3625901,
"status": "viewed"
}
],
"status": "incomplete"
},
"metadata":{
"token": "myloooooooongtokenbiggerthan12chars",
"event_type":"rs.signed",
"event_user_id": 1,
"client_id":"6xkfd7cC9TEcXPOy1jxbHg9k8O8IpmQRAt7AWrTm",
"event_user":"[email protected]"
}
}
rs.declined
{
"data":{
"aadhaar_enabled": null,
"created_time": 1557465368,
"has_markers": 0,
"id": 235649,
"is_in_person": 0,
"is_ordered": 1,
"last_modified_time": 1557465371,
"logo": null,
"name": "Offer letter - Prashanth.pdf",
"next": 377928,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "Sunil",
"owner_last_name": "Patro EK",
"owner_user_id": 3625900,
"recipients": [
{
"created_time": 1557465369,
"email": "[email protected]",
"first_name": "Prashanth",
"last_modified_time": 1591780421,
"last_name": "Raghu",
"order_id": 1,
"recipient_id": 377928,
"recipient_user_id": 3625901,
"status": "declined"
}
],
"status": "complete"
},
"metadata":{
"event_type":"rs.declined",
"event_user_id": 1,
"client_id":"6xkfd7cC9TEcXPOy1jxbHg9k8O8IpmQRAt7AWrTm",
"event_user":"[email protected]"
}
}
{
"data": {
"aadhaar_enabled": null,
"created_time": 1557465368,
"has_markers": 0,
"id": 235649,
"is_in_person": 0,
"is_ordered": 1,
"last_modified_time": 1557465371,
"logo": null,
"name": "Offer letter - Prashanth.pdf",
"next": 377928,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "Sunil",
"owner_last_name": "Patro EK",
"owner_user_id": 3625900,
"sources": [
{
"id": 223221,
"name": "Offer letter",
"type": "original"
}
],
"recipients": [
{
"created_time": 1557465369,
"email": "[email protected]",
"first_name": "Prashanth",
"last_modified_time": 1591780421,
"last_name": "Raghu",
"order_id": 1,
"recipient_id": 377928,
"recipient_user_id": 3625901,
"status": "declined"
}
],
"status": "complete"
},
"metadata": {
"token": "myloooooooongtokenbiggerthan12chars",
"event_type":"rs.declined",
"event_user_id": 1,
"client_id":"6xkfd7cC9TEcXPOy1jxbHg9k8O8IpmQRAt7AWrTm",
"event_user":"[email protected]"
}
}
rs.voided
{
"data":{
"aadhaar_enabled": null,
"created_time": 1557465368,
"has_markers": 0,
"id": 235649,
"is_in_person": 0,
"is_ordered": 1,
"last_modified_time": 1557465371,
"logo": null,
"name": "Offer letter - Prashanth.pdf",
"next": 377928,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "Sunil",
"owner_last_name": "Patro EK",
"owner_user_id": 3625900,
"recipients": [
{
"created_time": 1557465369,
"email": "[email protected]",
"first_name": "Prashanth",
"last_modified_time": 1591780421,
"last_name": "Raghu",
"order_id": 1,
"recipient_id": 377928,
"recipient_user_id": 3625901,
"status": "declined"
}
],
"status": "canceled"
},
"metadata":{
"event_type":"rs.voided",
"event_user_id": 1,
"client_id":"6xkfd7cC9TEcXPOy1jxbHg9k8O8IpmQRAt7AWrTm",
"event_user":"[email protected]"
}
}
{
"data":{
"aadhaar_enabled": null,
"created_time": 1557465368,
"has_markers": 0,
"id": 235649,
"is_in_person": 0,
"is_ordered": 1,
"last_modified_time": 1557465371,
"logo": null,
"name": "Offer letter - Prashanth.pdf",
"next": 377928,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "Sunil",
"owner_last_name": "Patro EK",
"owner_user_id": 3625900,
"sources": [
{
"id": 223221,
"name": "Offer letter",
"type": "original"
}
],
"recipients": [
{
"created_time": 1557465369,
"email": "[email protected]",
"first_name": "Prashanth",
"last_modified_time": 1591780421,
"last_name": "Raghu",
"order_id": 1,
"recipient_id": 377928,
"recipient_user_id": 3625901,
"status": "declined"
}
],
"status": "canceled"
},
"metadata": {
"token": "myloooooooongtokenbiggerthan12chars",
"event_type":"rs.voided",
"event_user_id": 1,
"client_id":"6xkfd7cC9TEcXPOy1jxbHg9k8O8IpmQRAt7AWrTm",
"event_user":"[email protected]"
}
}
rs.reminded
{
"data":{
"aadhaar_enabled": null,
"created_time": 1557465368,
"has_markers": 0,
"id": 235649,
"is_in_person": 0,
"is_ordered": 1,
"last_modified_time": 1557465371,
"logo": null,
"name": "Offer letter - Prashanth.pdf",
"next": 377928,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "Sunil",
"owner_last_name": "Patro EK",
"owner_user_id": 3625900,
"recipients": [
{
"created_time": 1557465369,
"email": "[email protected]",
"first_name": "Prashanth",
"last_modified_time": 1591780421,
"last_name": "Raghu",
"order_id": 1,
"recipient_id": 377928,
"recipient_user_id": 3625901,
"status": "not_viewed"
}
],
"status": "incomplete"
},
"metadata":{
"event_type":"rs.remind",
"event_user_id": 1,
"client_id":"6xkfd7cC9TEcXPOy1jxbHg9k8O8IpmQRAt7AWrTm",
"event_user":"[email protected]"
}
}
{
"data":{
"aadhaar_enabled": null,
"created_time": 1557465368,
"has_markers": 0,
"id": 235649,
"is_in_person": 0,
"is_ordered": 1,
"last_modified_time": 1557465371,
"logo": null,
"name": "Offer letter - Prashanth.pdf",
"next": 377928,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "Sunil",
"owner_last_name": "Patro EK",
"owner_user_id": 3625900,
"sources": [
{
"id": 223221,
"name": "Offer letter",
"type": "original"
}
],
"recipients": [
{
"created_time": 1557465369,
"email": "[email protected]",
"first_name": "Prashanth",
"last_modified_time": 1591780421,
"last_name": "Raghu",
"order_id": 1,
"recipient_id": 377928,
"recipient_user_id": 3625901,
"status": "not_viewed"
}
],
"status": "incomplete"
},
"metadata":{
"token": "myloooooooongtokenbiggerthan12chars",
"event_type":"rs.remind",
"event_user_id": 1,
"client_id":"6xkfd7cC9TEcXPOy1jxbHg9k8O8IpmQRAt7AWrTm",
"event_user":"[email protected]"
}
}
rs.completed
{
"data":{
"aadhaar_enabled": null,
"created_time": 1557465368,
"has_markers": 0,
"id": 235649,
"is_in_person": 0,
"is_ordered": 1,
"last_modified_time": 1557465371,
"logo": null,
"name": "Offer letter - Prashanth.pdf",
"next": 377928,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "Sunil",
"owner_last_name": "Patro EK",
"owner_user_id": 3625900,
"recipients": [
{
"created_time": 1557465369,
"email": "[email protected]",
"first_name": "Prashanth",
"last_modified_time": 1591780621,
"last_name": "Raghu",
"order_id": 1,
"recipient_id": 377928,
"recipient_user_id": 3625901,
"status": "finalized"
}
],
"status": "complete"
},
"metadata":{
"event_type":"rs.completed",
"event_user_id": 1,
"client_id":"6xkfd7cC9TEcXPOy1jxbHg9k8O8IpmQRAt7AWrTm",
"event_user":"[email protected]"
}
}
{
"data":{
"aadhaar_enabled": null,
"created_time": 1557465368,
"has_markers": 0,
"id": 235649,
"is_in_person": 0,
"is_ordered": 1,
"last_modified_time": 1557465371,
"logo": null,
"name": "Offer letter - Prashanth.pdf",
"next": 377928,
"owner_company": "",
"owner_email": "[email protected]",
"owner_first_name": "Sunil",
"owner_last_name": "Patro EK",
"owner_user_id": 3625900,
"sources": [
{
"id": 223221,
"name": "Offer letter",
"type": "original"
}
],
"recipients": [
{
"created_time": 1557465369,
"email": "[email protected]",
"first_name": "Prashanth",
"last_modified_time": 1591780621,
"last_name": "Raghu",
"order_id": 1,
"recipient_id": 377928,
"recipient_user_id": 3625901,
"status": "finalized"
}
],
"status": "complete"
},
"metadata": {
"token": "myloooooooongtokenbiggerthan12chars",
"event_type":"rs.completed",
"event_user_id": 1,
"client_id":"6xkfd7cC9TEcXPOy1jxbHg9k8O8IpmQRAt7AWrTm",
"event_user":"[email protected]"
}
}
Updated over 3 years ago