Agreement (V2) webhook events

Definition of webhook events that are triggered on when (V2) agreements are sent, viewed, or signed

Geoff Mina avatar
Written by Geoff Mina
Updated over a week ago

X-Event-Type values

  • AgreementSent

  • AgreementViewed

  • AgreementSigned
    โ€‹

{
"id": "65aa697ad7589168ea152499",
"accountId": 10016,
"name": "New agreement with Test",
"client": {
"accountId": 10016,
"sampleData": false,
"id": "60b6547fc5f3ce00017353c9",
"clientType": "Client",
"name": "Test",
"initials": null,
"locality": "",
"country": null,
"color": "#FACBCB",
"address1": "",
"address2": null,
"city": "",
"postal": "",
"website": null,
"phone": null,
"s3LogoFile": null,
"taxId": null,
"projects": [],
"hourlyAmount": 0,
"archive": false,
"currency": "USD",
"logo": null,
"leadSource": null,
"defaultTaxRate": null,
"customValues": [],
"contact": {
"id": "65aa661ad034124011c3779d",
"accountId": 10016,
"clientId": "60b6547fc5f3ce00017353c9",
"clientPortalUserId": -116,
"firstName": "Geoffrey",
"lastName": "Mina",
"role": null,
"phone": null,
"email": "geoff@someemail.com",
"mobile": null,
"notes": null,
"defaultContact": false,
"invoiceContact": false,
"portalAccess": false,
"customValues": [],
"importRecordId": null,
"sampleData": null
}
},
"account": {
"accountId": 10016,
"accountName": "Moxie",
"accountLogo": "https://hectic-public.s3.us-east-2.amazonaws.com/00379433-b883-46b4-9ff3-869231231469.png",
"accountLogoDark": "https://hectic-public.s3.us-east-2.amazonaws.com/52730bac-14da-4be0-a208-d94fecc96b89.png",
"currency": "USD",
"country": "US",
"taxLabel": "GST",
"stripeAccountId": "",
"defaultTaxRate": 15,
"uniqueUrlPath": "hectic-lab",
"address1": "123 Some St",
"address2": "",
"city": "Longmont",
"locality": "CO",
"postal": "80503",
"website": "https://www.withmoxie.com",
"phone": "555-555-5555",
"payInstructions": "",
"taxId": null
},
"status": "Finalized",
"statusTime": "2024-01-19T12:22:44.551Z",
"currency": "USD",
"dateCreated": "2024-01-19T12:22:18.139Z",
"dateCompleted": "2024-01-19T12:23:45.113Z",
"lastEvent": {
"event": "Geoffrey Mina signed",
"timestamp": "2024-01-19T12:23:45.113Z"
},
"fullyExecuted": true,
"userSigned": true,
"clientSigned": true,
"formData": [
{
"firstName": null,
"lastName": null,
"email": null,
"phone": null,
"role": null,
"businessName": null,
"website": null,
"address1": "123 Any St",
"address2": null,
"city": "Saratoga Springs",
"locality": "NY",
"postal": "12866",
"country": null,
"sourceUrl": null,
"opportunityId": null,
"templateId": "656b8342a825dc64300865ea",
"cardTokenId": null,
"leadSource": null,
"clientId": "60b6547fc5f3ce00017353c9",
"answers": []
}
],
"scheduledMeetings": [
{
"id": "65aa69d1d7589168ea15249c",
"accountId": 10016,
"ownerUserId": null,
"sampleData": false,
"meetingId": "646ba9d3a4b16c49eb035c48",
"clientId": "60b6547fc5f3ce00017353c9",
"meetingStatus": "Scheduled",
"meetingName": "Geoffrey Mina / 15 Minute Meeting",
"schedulerName": "15 Minute Meeting",
"confirmedTime": {
"start": "2024-01-19T17:30:00.000Z",
"end": "2024-01-19T18:00:00.000Z"
},
"scheduledTimezone": "America/New_York",
"scheduledLocale": "en-US",
"formData": {
"firstName": "Geoffrey",
"lastName": "Mina",
"email": "geoff@someemail.com",
"phone": null,
"role": null,
"businessName": null,
"website": null,
"address1": null,
"address2": null,
"city": null,
"locality": null,
"postal": null,
"country": null,
"sourceUrl": null,
"opportunityId": null,
"templateId": null,
"cardTokenId": null,
"leadSource": null,
"clientId": null,
"answers": []
},
"ipLookup": null,
"location": {
"type": "Sessions",
"googleUserId": null,
"zoomUserId": 16,
"microsoftUserId": null,
"sessionsUserId": 16,
"calendarId": null,
"subCalendarId": null,
"phone": null,
"address": null,
"custom": null
},
"zoomMeeting": null,
"googleMeeting": {
"googleUserId": 16,
"eventId": "_6oqm2o9m75i32p1n6ks3ic9m71im2c9l68q3ioq0etkn8q3ddts6i",
"hangoutLink": null,
"htmlLink": "https://www.google.com/calendar/event?eid=XzZvcW0ybzltNzVpMzJwMW42a3MzaWM5bTcxaW0y",
"googleUser": {
"name": "Geoff Mina",
"given_name": "Geoff",
"family_name": "Mina",
"picture": "https://lh3.googleusercontent.com/a/AGNmyxYxJL9h8SnY6z2oXg",
"email": "geoff.mina@withmoxie.us",
"email_verified": true,
"locale": "en"
},
"entryPoints": []
},
"microsoftEvent": null,
"sessionEvent": {
"id": "2369b91d-73b6-4f0e",
"name": "Geoffrey Mina / 15 Minute Meeting",
"startAt": "2024-01-19T17:30:00.000Z",
"plannedEnd": "2024-01-19T18:00:00.000Z",
"createdAt": "2024-01-19T12:23:46.354Z",
"updatedAt": "2024-01-19T12:23:46.354Z",
"timeZone": "America/Denver",
"sessionLink": "https://app.sessions.us/session/2369b91d-73b6",
"sessionsUserId": 16
},
"connectedICalUid": null,
"notes": null,
"cancellationReason": null,
"cancelUrl": "https://clients1.geoffreymina.com/public/hectic-lab/15-minute-meeting/?id=65aa69d1d7589168ea15249c&action=cancel",
"rescheduleUrl": "https://clients1.geoffreymina.com/public/hectic-lab/15-minute-meeting/?id=65aa69d1d7589168ea15249c&action=change",
"leadGenArchived": false,
"opportunityId": null,
"agreementId": "65aa697ad7589168ea152499",
"files": [],
"meetingWith": "Moxie",
"incomeRecordId": null,
"icalUid": "65aa69d1d7589168ea15249c@withmoxie.com"
}
],
"selectedPackages": [
{
"id": "0fdb10f0-f3ac-4957-8103-da6977321bcc",
"packageName": "Minimal Service Package",
"description": "<h2>{{Package.Name}}</h2>\n<div><br />Description that shows the price of the package<br />{{Package.Total}} {{Package.FeeLabel}}<br /><br />You are free to add on any additionl options that you want</div>",
"items": [
{
"id": "06b93989-77e4-4600-a548-50a1f716e236",
"description": "Add-on One",
"product": {
"id": "63611e24de52540001e3c141",
"accountId": 10102,
"productName": "Website Design",
"description": null,
"unit": "Website",
"rate": 500,
"hourly": false,
"taxable": false,
"deposit": false,
"currencyRates": []
},
"quantity": 1,
"rate": 500,
"taxable": false,
"relativeDueDate": true,
"dueDate": null,
"dueDateRelative": {
"duration": null,
"timeUnit": "WEEKS"
},
"assignedToList": [],
"tasks": [],
"addOnItem": true,
"optional": true,
"oneTimeFee": true,
"selected": true
},
{
"id": "39f89d3b-6bd3-402c-9c72-34307e27939a",
"description": "Add-on Two",
"product": {
"id": "63611e2ede52540001e3c142",
"accountId": 10102,
"productName": "Logo Design",
"description": null,
"unit": "Logo",
"rate": 750,
"hourly": false,
"taxable": false,
"deposit": false,
"currencyRates": []
},
"quantity": 1,
"rate": 750,
"taxable": false,
"relativeDueDate": true,
"dueDate": null,
"dueDateRelative": {
"duration": null,
"timeUnit": "WEEKS"
},
"assignedToList": [],
"tasks": [],
"addOnItem": true,
"optional": true,
"oneTimeFee": true,
"selected": true
}
],
"fees": {
"feeType": "Fixed Price",
"amount": 500,
"retainerSchedule": "Monthly",
"estimateMax": 0,
"estimateMin": 0,
"retainerStart": null,
"retainerTiming": "Advanced",
"retainerOverageRate": null,
"taxable": false,
"fromProposalId": null,
"fromProposalSignedDate": null,
"updatedDate": null,
"updatedBy": null
},
"startDate": null,
"overrideDeliverablePackageId": null,
"selected": true,
"buttonText": "Select",
"depositAmount": 0
}
],
"scheduledPayments": [
{
"id": "ba309f73-1baa-41f8-9a92-07cf0f1dacb9",
"label": "Due upon signing",
"triggerType": "Immediate",
"triggerDate": null,
"relativeTriggerDate": {
"duration": 1,
"timeUnit": "WEEKS"
},
"mileStoneAchieved": false,
"amountType": "Percentage",
"amount": 33,
"finalPayment": false,
"invoiceDate": null,
"invoiceId": null,
"invoiceNumberFormatted": null,
"calculatedPercentage": 33,
"calculatedAmount": 577.5
},
{
"id": "3b63df45-0618-48b0-9a51-ebcfa646416a",
"label": "Midway check-in",
"triggerType": "Milestone",
"triggerDate": "2024-01-05",
"relativeTriggerDate": {
"duration": 1,
"timeUnit": "WEEKS"
},
"mileStoneAchieved": false,
"amountType": "Percentage",
"amount": 33,
"finalPayment": false,
"invoiceDate": null,
"invoiceId": null,
"invoiceNumberFormatted": null,
"calculatedPercentage": 33,
"calculatedAmount": 577.5
},
{
"id": "1da66b4b-88fe-4a94-a49c-08d633060344",
"label": "Final payment - At completion of project",
"triggerType": "Milestone",
"triggerDate": null,
"relativeTriggerDate": {
"duration": 1,
"timeUnit": "WEEKS"
},
"mileStoneAchieved": false,
"amountType": "Percentage",
"amount": 34,
"finalPayment": true,
"invoiceDate": null,
"invoiceId": null,
"invoiceNumberFormatted": null,
"calculatedPercentage": 34,
"calculatedAmount": 595
}
],
"signers": [
{
"id": "wj5im",
"firstName": "Geoffrey",
"lastName": "Mina",
"title": "df",
"email": "geoff@purecallerid.com",
"extra": "",
"signerType": "CLIENT",
"signatureType": "Keyboard",
"font": "Arizonia",
"signature": "Geoffrey Mina",
"initials": "GM",
"ip": {
"ip": null,
"city": null,
"region": null,
"country": null,
"countryFlag": null
},
"timestamp": "2024-01-19T12:23:45.106Z",
"locked": true,
"fullName": "Geoffrey Mina"
},
{
"id": "rjd8e",
"firstName": "Geoffrey",
"lastName": "Mina",
"title": "CEO",
"email": "geoff.mina@hectic.us",
"extra": "",
"signerType": "USER",
"signatureType": "Keyboard",
"font": "Arizonia",
"signature": "Geoffrey Mina",
"initials": "GM",
"ip": {
"ip": null,
"city": null,
"region": null,
"country": null,
"countryFlag": null
},
"timestamp": "2024-01-19T12:22:18.533Z",
"locked": true,
"fullName": "Geoffrey Mina"
}
]
}
Did this answer your question?