Webhooks
Webhook Topics
request.created
request.created topic is triggered when a new request is created. The data object in the event payload represents the new request.Sample Payload
{
"event_id": "0b11e21d-85f3-4e30-b3e9-1a260c25070e",
"topic": "request.created",
"organization_id": "0",
"data": {
"id": "74e85389-2f99-45ab-8535-b986bedd7759",
"state": "INCOMPLETE_AND_LINK_SENT",
"owner_id": "0",
"owner_opened": true,
"user_opened": true,
"name": "Request Name",
"due_date": "2025-01-01T00:00.00",
"submission_date": "2025-01-01T00:00.00",
"expiration_date": null,
"personal_message": null,
"security_question": null,
"language": "en-US",
"reminders": "NONE",
"items": [
{
"id": "1a3126ba-9bce-4096-8d73-f2c704837741",
"type": "STANDARD",
"name": "Form Item",
"description": null,
"required": true
},
{
"id": "7ad70695-677f-4fd1-92c1-f6c7b3ab132e",
"type": "E_SIGNATURE",
"name": "ESignature Item",
"description": null,
"required": true
},
{
"id": "f43476bf-2e1b-4ca7-8cba-4522ec75321f",
"type": "QUESTION",
"name": "Question Item",
"description": null,
"required": true
}
],
"recipients": [
{
"first_name": "Pigeon",
"last_name": "User",
"email": "support@pigeondocuments.com",
"phone": "",
"request_link": null,
"auth": "NONE"
}
],
"collaborators": []
}
}request.updated
request.updated topic is triggered when a request is updated. The data object in the event payload represents the updated request.updated object that specifies the attributes that were updated.Sample Payload
{
"event_id": "0b11e21d-85f3-4e30-b3e9-1a260c25070e",
"topic": "request.updated",
"organization_id": "0",
"data": {
"id": "74e85389-2f99-45ab-8535-b986bedd7759",
"state": "PARTIALLY_SUBMITTED",
"owner_id": "0",
"owner_opened": true,
"user_opened": true,
"name": "Updated Request Name",
"due_date": "2025-01-01T00:00.00",
"submission_date": "2025-01-01T00:00.00",
"expiration_date": null,
"personal_message": null,
"security_question": null,
"language": "en-US",
"reminders": "NONE",
"items": [
{
"id": "1a3126ba-9bce-4096-8d73-f2c704837741",
"type": "STANDARD",
"name": "Form Item",
"description": null,
"required": true
},
{
"id": "7ad70695-677f-4fd1-92c1-f6c7b3ab132e",
"type": "E_SIGNATURE",
"name": "ESignature Item",
"description": null,
"required": true
},
{
"id": "f43476bf-2e1b-4ca7-8cba-4522ec75321f",
"type": "QUESTION",
"name": "Question Item",
"description": null,
"required": true
}
],
"recipients": [
{
"first_name": "Pigeon",
"last_name": "User",
"email": "support@pigeondocuments.com",
"phone": "",
"request_link": null,
"auth": "NONE"
}
],
"collaborators": []
},
"updated": {
"name": "Updated Request Name",
"due_date": "2025-01-01T00:00.00",
}
}request.deleted
request.deleted topic is triggered when a request is deleted. The data object in the event payload represents the deleted request.Sample Payload
{
"event_id": "0b11e21d-85f3-4e30-b3e9-1a260c25070e",
"topic": "request.deleted",
"organization_id": "0",
"data": {
"id": "74e85389-2f99-45ab-8535-b986bedd7759",
"state": "SUBMITTED",
"owner_id": "0",
"owner_opened": true,
"user_opened": true,
"name": "Updated Request Name",
"due_date": "2025-01-01T00:00.00",
"submission_date": "2025-01-01T00:00.00",
"expiration_date": null,
"personal_message": null,
"security_question": null,
"language": "en-US",
"reminders": "NONE",
"items": [
{
"id": "1a3126ba-9bce-4096-8d73-f2c704837741",
"type": "STANDARD",
"name": "Form Item",
"description": null,
"required": true
},
{
"id": "7ad70695-677f-4fd1-92c1-f6c7b3ab132e",
"type": "E_SIGNATURE",
"name": "ESignature Item",
"description": null,
"required": true
},
{
"id": "f43476bf-2e1b-4ca7-8cba-4522ec75321f",
"type": "QUESTION",
"name": "Question Item",
"description": null,
"required": true
}
],
"recipients": [
{
"first_name": "Pigeon",
"last_name": "User",
"email": "support@pigeondocuments.com",
"phone": "",
"request_link": null,
"auth": "NONE"
}
],
"collaborators": []
}
}request.submitted
request.submitted topic is triggered when a recipient creates a submission for a request. The data object in the event payload represents the request.submission object that includes details related to the submission. This object specifies the following attributes:| Attribute | Type | Description |
|---|---|---|
recipient | object | The recipient who created the submission |
status | enum | Indicates the completion status of the request (COMPLETE or PARTIAL) |
message | string | Custom message submitted from recipient |
submitted_at | datetime | Timestamp of submission |
items | object[] | Array of items included in the submission |
Sample Payload
{
"event_id": "0b11e21d-85f3-4e30-b3e9-1a260c25070e",
"topic": "request.submitted",
"organization_id": "0",
"data": {
"id": "74e85389-2f99-45ab-8535-b986bedd7759",
"state": "PARTIALLY_SUBMITTED",
"owner_id": "0",
"owner_opened": true,
"user_opened": true,
"name": "Updated Request Name",
"due_date": "2025-01-01T00:00.00",
"submission_date": "2025-01-01T00:00.00",
"expiration_date": null,
"personal_message": null,
"security_question": null,
"language": "en-US",
"reminders": "NONE",
"items": [
{
"id": "1a3126ba-9bce-4096-8d73-f2c704837741",
"type": "STANDARD",
"name": "Form Item",
"description": null,
"required": true
},
{
"id": "7ad70695-677f-4fd1-92c1-f6c7b3ab132e",
"type": "E_SIGNATURE",
"name": "ESignature Item",
"description": null,
"required": true
},
{
"id": "f43476bf-2e1b-4ca7-8cba-4522ec75321f",
"type": "QUESTION",
"name": "Question Item",
"description": null,
"required": true
}
],
"recipients": [
{
"first_name": "Pigeon",
"last_name": "User",
"email": "support@pigeondocuments.com",
"phone": "",
"request_link": null,
"auth": "NONE"
}
],
"collaborators": []
},
"submission": {
"recipient": {
"first_name": "Pigeon",
"last_name": "User",
"email": "support@pigeondocuments.com",
"phone": "",
"request_link": null,
"auth": "NONE"
},
"status": "PARTIAL",
"message": "Here's my submission!",
"submitted_at": "2025-01-01T00:00.00",
"items": [
{
"id": "1a3126ba-9bce-4096-8d73-f2c704837741",
"type": "STANDARD",
"name": "Form Item",
"description": null,
"required": true
}
]
}
}request.verified
request.verified topic is triggered when a requesting users manually validates (accepts) the recipient's submission. The data object in the event payload represents the verified request.Sample Payload
{
"event_id": "0b11e21d-85f3-4e30-b3e9-1a260c25070e",
"topic": "request.verified",
"organization_id": "0",
"data": {
"id": "74e85389-2f99-45ab-8535-b986bedd7759",
"state": "VERIFIED",
"owner_id": "0",
"owner_opened": true,
"user_opened": true,
"name": "Updated Request Name",
"due_date": "2025-01-01T00:00.00",
"submission_date": "2025-01-01T00:00.00",
"expiration_date": null,
"personal_message": null,
"security_question": null,
"language": "en-US",
"reminders": "NONE",
"items": [
{
"id": "1a3126ba-9bce-4096-8d73-f2c704837741",
"type": "STANDARD",
"name": "Form Item",
"description": null,
"required": true
},
{
"id": "7ad70695-677f-4fd1-92c1-f6c7b3ab132e",
"type": "E_SIGNATURE",
"name": "ESignature Item",
"description": null,
"required": true
},
{
"id": "f43476bf-2e1b-4ca7-8cba-4522ec75321f",
"type": "QUESTION",
"name": "Question Item",
"description": null,
"required": true
}
],
"recipients": [
{
"first_name": "Pigeon",
"last_name": "User",
"email": "support@pigeondocuments.com",
"phone": "",
"request_link": null,
"auth": "NONE"
}
],
"collaborators": []
}
}request.rejected
request.rejected topic is triggered when a requesting user requests changes to a user's submission. The data object in the event payload represents the rejected request.rejection object that includes details related to the rejection request. This object specifies the following attributes:| Attribute | Type | Description |
|---|---|---|
message | string | The custom message sent to the request recipient |
keep_original | bool | Indicates if the originally uploaded files were kept (true) or deleted (false) |
items | object[] | Array of items that changes were requested for. |
items.id | string | ID of item. |
items.reason | string | Message describing why the item was rejected and what changes are requested. |
Sample Payload
{
"event_id": "0b11e21d-85f3-4e30-b3e9-1a260c25070e",
"topic": "request.rejected",
"organization_id": "0",
"data": {
"id": "74e85389-2f99-45ab-8535-b986bedd7759",
"state": "REJECTED",
"owner_id": "0",
"owner_opened": true,
"user_opened": true,
"name": "Request Name",
"due_date": "2025-01-01T00:00.00",
"submission_date": "2025-01-01T00:00.00",
"expiration_date": null,
"personal_message": null,
"security_question": null,
"language": "en-US",
"reminders": "NONE",
"items": [
{
"id": "1a3126ba-9bce-4096-8d73-f2c704837741",
"type": "STANDARD",
"name": "Form Item",
"description": null,
"required": true
},
{
"id": "7ad70695-677f-4fd1-92c1-f6c7b3ab132e",
"type": "E_SIGNATURE",
"name": "ESignature Item",
"description": null,
"required": true
},
{
"id": "f43476bf-2e1b-4ca7-8cba-4522ec75321f",
"type": "QUESTION",
"name": "Question Item",
"description": null,
"required": true
}
],
"recipients": [
{
"first_name": "Pigeon",
"last_name": "User",
"email": "support@pigeondocuments.com",
"phone": "",
"request_link": null,
"auth": "NONE"
}
],
"collaborators": []
},
"rejection": {
"message": "Please fix these items!",
"keep_original": true,
"items": [
{
"id": "1a3126ba-9bce-4096-8d73-f2c704837741",
"reason": "Change this!"
},
{
"id": "7ad70695-677f-4fd1-92c1-f6c7b3ab132e",
"reason": "Change that!"
}
]
}
}request.opened
request.opened topic is triggered when a recipient opens a request. It is only fired once per request.data object in the event payload represents the opened request. The event payload also includes an opened_by object that specifies the recipient who opened the request.Sample Payload
{
"event_id": "0b11e21d-85f3-4e30-b3e9-1a260c25070e",
"topic": "request.opened",
"organization_id": "0",
"data": {
"id": "74e85389-2f99-45ab-8535-b986bedd7759",
"state": "INCOMPLETE_AND_LINK_SENT",
"owner_id": "0",
"owner_opened": true,
"user_opened": true,
"name": "Updated Request Name",
"due_date": "2025-01-01T00:00.00",
"submission_date": "2025-01-01T00:00.00",
"expiration_date": null,
"personal_message": null,
"security_question": null,
"language": "en-US",
"reminders": "NONE",
"items": [
{
"id": "1a3126ba-9bce-4096-8d73-f2c704837741",
"type": "STANDARD",
"name": "Form Item",
"description": null,
"required": true
},
{
"id": "7ad70695-677f-4fd1-92c1-f6c7b3ab132e",
"type": "E_SIGNATURE",
"name": "ESignature Item",
"description": null,
"required": true
},
{
"id": "f43476bf-2e1b-4ca7-8cba-4522ec75321f",
"type": "QUESTION",
"name": "Question Item",
"description": null,
"required": true
}
],
"recipients": [
{
"first_name": "Pigeon",
"last_name": "User",
"email": "support@pigeondocuments.com",
"phone": "",
"request_link": null,
"auth": "NONE"
}
],
"collaborators": []
},
"opened_by": {
"first_name": "Pigeon",
"last_name": "User",
"email": "support@pigeondocuments.com",
"phone": "",
"request_link": null,
"auth": "NONE"
}
}Modified at 2025-01-15 18:32:33