This reference covers the webhook event names currently available for this record type and an example JSON payload.
X-Event-Type values
ProposalSentProposalViewedProposalSigned
These event names apply only to existing legacy V1 proposal/agreement webhooks. Configure new agreement webhooks with AgreementSent or AgreementSigned.
Payloads reflect the record at delivery time and may gain additional fields. Integrations should ignore unknown fields and use the event type plus stable record IDs rather than depending on property order.
Example payload
{
"id": "64b81fbfe316362e9a290ea3",
"accountId": 10016,
"sampleData": false,
"isFullyExecuted": false,
"client": {
"accountId": 10016,
"sampleData": false,
"id": "6490580de30ecf51c2c22ffa",
"clientType": "Client",
"name": "E164",
"initials": null,
"locality": "NY",
"country": "US",
"color": "#8EA3B8",
"projects": [],
"hourlyAmount": 150,
"archive": false,
"currency": "USD",
"logo": null,
"leadSource": null,
"contact": {
"id": "6490580de30ecf51c2c22ffb",
"accountId": 10016,
"clientId": "6490580de30ecf51c2c22ffa",
"clientPortalUserId": -79,
"firstName": "Geoffrey",
"lastName": "Mina",
"role": null,
"phone": "+19546496707",
"email": "geoff@purecallerid.com",
"mobile": null,
"notes": null,
"defaultContact": true,
"invoiceContact": false,
"portalAccess": true,
"importRecordId": null,
"sampleData": null
}
},
"dateCreated": "2023-07-19T17:39:11.288Z",
"dateSent": "2023-07-19T17:39:29.237Z",
"dateSigned": null,
"coverPage": {
"theme": "light",
"image": "https://images.unsplash.com/photo-1444927714506-8492d94b4e3d?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEzODE4OX0",
"imageDownload": "https://api.unsplash.com/photos/xJ2tjuUHD9M/download",
"imageThumb": "https://images.unsplash.com/photo-1444927714506-8492d94b4e3d?ixlib=rb-1.2.1&q=80&fm=jpg&crop=entropy&cs=tinysrgb&w=200&fit=max&ixid=eyJhcHBfaWQiOjEzODE4OX0",
"heading": "Proposal for Services",
"showLogo": true,
"customFor": null,
"customBy": null,
"headingPosition": "Prominent"
},
"proposalStatus": "Sent",
"proposalType": "Proposal",
"lastEvent": {
"event": "Sent",
"timestamp": "2023-07-19T17:39:29.237Z"
},
"leadGenArchived": false,
"currency": "USD",
"deliverables": [
{
"blockType": "Deliverables",
"id": "ad0d8207-a043-4aca-9dda-03f730fb8a33",
"header": "Work for hire",
"deliverables": [
{
"id": "20e9a307-880b-4905-9a51-42ab027b4994",
"deliverable": "Item 1",
"description": null,
"dueDate": null,
"dueDateRelative": {
"duration": 2,
"timeUnit": "WEEKS"
},
"product": null,
"quantity": null,
"showPricingDetail": true,
"initialSetupTask": false,
"tasks": [],
"assignedToList": []
},
{
"id": "9fa889de-0a46-46aa-a3ad-ae28806a6c21",
"deliverable": "Item 2",
"description": null,
"dueDate": null,
"dueDateRelative": {
"duration": 2,
"timeUnit": "WEEKS"
},
"product": null,
"quantity": null,
"showPricingDetail": true,
"initialSetupTask": false,
"tasks": [],
"assignedToList": []
}
],
"feeSchedule": {
"feeType": "Hourly",
"amount": 100,
"retainerSchedule": null,
"estimateMax": 0,
"estimateMin": 0,
"retainerStart": null,
"retainerTiming": "Advanced",
"retainerOverageRate": null,
"taxable": false,
"fromProposalId": null,
"fromProposalSignedDate": null,
"updatedDate": null,
"updatedBy": null
},
"selectedPackage": false,
"taxRate": 5,
"deliverableAutomation": {
"autoCreateProject": true,
"projectName": null,
"autoInvoice": true,
"approvalRequired": true,
"invoicePercentage": true,
"invoiceAmount": 50,
"paymentRequiredToStart": true,
"overrideDeliverablePackageId": null
}
}
],
"signatureBlock": {
"blockType": "SignatureBlock",
"id": "22fc877c-c281-4eaa-aec4-873279665136",
"header": "Signatures",
"us": {
"type": "Keyboard",
"font": "Arizonia",
"signature": "",
"signerName": "Geoffrey Mina",
"signerTitle": null,
"signerLocked": false,
"dts": null,
"ip": {
"ip": null,
"city": null,
"region": null,
"country": null,
"countryFlag": null
}
},
"them": {
"type": "Keyboard",
"font": "Arizonia",
"signature": null,
"signerName": null,
"signerTitle": null,
"signerLocked": false,
"dts": null,
"ip": {
"ip": null,
"city": null,
"region": null,
"country": null,
"countryFlag": null
}
}
}
}
For delivery setup and troubleshooting, see Configure event webhooks. The generated Webhooks & Events documentation is the source of truth for the current event catalog.