Webhook

Parameters

Name	Type	Description	Requirement
type	String	The event type	Required
companyId	Integer	The company identifier	Required
templateId	Integer	The template identifier	Optional
templateName	String	The template name	Optional
ownerId	Integer	The owner identifier	Required
ownerName	String	The owner name	Required
senderId	Integer	The sender identifier	Optional
senderName	String	The sender name	Optional
signRequestId	Integer	The sign request identifier	Optional
signRequestName	String	The sign request name	Optional
participantId	Integer	The participant identifier	Optional
participantName	String	The participant name	Optional
roleId	Integer	The role identifier	Optional
roleName	String	The role name	Optional

Example Responses

JSON

{
  "type": "template-activated",
  "companyId": 94,
  "templateId": 1987440,
  "templateName": "Webhook Test",
  "ownerId": 1342,
  "ownerName":"First Last"
}

JSON

{
  "type": "template-inactivated",
  "companyId": 94,
  "templateId": 1987440,
  "templateName": "Webhook Test",
  "ownerId": 1342,
  "ownerName":"First Last"
}

JSON

{
  "type": "template-deleted",
  "companyId": 94,
  "templateId": 1987440,
  "templateName": "Webhook Test",
  "ownerId": 1342,
  "ownerName":"First Last"
}

JSON

{
  "type": "sign-request-sent",
  "companyId": 94,
  "signRequestId": 1987442,
  "signRequestName": "Webhook Test 2",
  "templateId": 159,
  "templateName": "Webhook Test 2",
  "senderId": 137,
  "senderName": "First Last",
  "ownerId": 1342,
  "ownerName":"First Last"
}

JSON

{
  "type": "sign-request-completed",
  "companyId": 94,
  "signRequestId": 1987442,
  "signRequestName": "Webhook Test 2",
  "templateId": 159,
  "templateName": "Webhook Test 2",
  "senderId": 137,
  "senderName": "First Last",  
  "ownerId": 1342,
  "ownerName":"First Last"
}

JSON

{
  "type": "sign-request-declined",
  "companyId": 94,
  "signRequestId": 1987443,
  "signRequestName": "Webhook Test 3",
  "senderId": 137,
  "senderName": "First Last",
  "ownerId": 1342,
  "ownerName":"First Last"
}

JSON

{
  "type": "sign-request-deleted",
  "companyId": 94,
  "signRequestId": 1987443,
  "signRequestName": "Webhook Test 3",
  "senderId": 137,
  "senderName": "First Last",
  "ownerId": 1342,
  "ownerName":"First Last"
}

JSON

{
  "type": "participant-sent",
  "companyId": 94,
  "signRequestId": 1987442,
  "signRequestName": "Webhook Test 2",
  "templateId": 159,
  "templateName": "Webhook Test 2",
  "participantId": 1858055,
  "partcipantName":"First Last",
  "roleId": 123528,
  "roleName": "Tester",
  "senderId": 137,
  "senderName": "First Last",
  "ownerId": 1342,
  "ownerName":"First Last"
}

JSON

{
  "type": "participant-viewed",
  "companyId": 94,
  "signRequestId": 1987443,
  "signRequestName": "Webhook Test 3",
  "participantId": 1858055,
  "partcipantName":"First Last",
  "roleId": 123528,
  "senderId": 137,
  "senderName": "First Last",
  "ownerId": 1342,
  "roleName": "Tester",
  "ownerName":"First Last"
}

JSON

{
  "type": "participant-downloaded",
  "companyId": 94,
  "signRequestId": 1987443,
  "signRequestName": "Webhook Test 3",
  "participantId": 1858055,
  "partcipantName":"First Last",
  "roleId": 123528,
  "roleName": "Tester",
  "senderId": 137,
  "senderName": "First Last",
  "ownerId": 1342,
  "ownerName":"First Last"
}

JSON

{
  "type": "participant-signed",
  "companyId": 94,
  "signRequestId": 1987442,
  "signRequestName": "Webhook Test 2",
  "templateId": 159,
  "templateName": "Webhook Test 2",
  "participantId": 1858055,
  "partcipantName":"First Last",
  "roleId": 123528,
  "roleName": "Tester",
  "senderId": 137,
  "senderName": "First Last",
  "ownerId": 1342,
  "ownerName":"First Last"
}

JSON

{
  "type": "participant-declined",
  "companyId": 94,
  "signRequestId": 1987443,
  "signRequestName": "Webhook Test 3",
  "participantId": 1858055,
  "partcipantName":"First Last",
  "roleId": 123528,
  "roleName": "Tester",
  "senderId": 137,
  "senderName": "First Last",
  "ownerId": 1342,
  "ownerName":"First Last"
}