Skip to main content

Client webhook events

Reference ClientCreate and ClientUpdate webhook payloads.

Written by Geoff Mina

This reference covers the webhook event names currently available for this record type and an example JSON payload.

X-Event-Type values

  • ClientCreate

  • ClientUpdate

New Custom API webhooks expose client creation and update events.

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": "63c5ea0c840e3207033931b5",
"accountId": 10016,
"name": "Moxie",
"clientType": "Client",
"initials": "MOX",
"address1": "123 Any Street",
"address2": "Suite 100",
"city": "Anytown",
"locality": "NY",
"postal": "12345",
"country": "US",
"website": "www.withmoxie.com",
"phone": "+18887231235",
"color": "#CE62E9",
"logo": "https://t3.gstatic.com/faviconV2?client=SOCIAL&type=FAVICON&fallback_opts=TYPE,SIZE,URL&url=https://www.withmoxie.com&size=64",
"s3LogoFile": null,
"taxId": "1212121212",
"leadSource": "PPC",
"archive": false,
"leadGenArchived": false,
"paymentTerms": {
"paymentDays": 7,
"latePaymentFee": 5,
"depositAmount": 50,
"depositType": "Percentage",
"whoPaysCardFees": "Freelancer",
"fromProposalId": "640b60752a524d1c45b6c528",
"fromProposalSignedDate": "2023-03-14T14:41:01.908Z",
"updatedDate": "2023-04-04T16:17:27.315Z",
"updatedBy": "G. Mina"
},
"payInstructions": null,
"hourlyAmount": 100,
"roundingIncrement": 1,
"currency": "USD",
"lastInvoiceRunDate": null,
"nextInvoiceRunDate": null,
"importRecordId": null,
"integrationKeys": {
"quickbooksId": null,
"xeroId": null
},
"files": [],
"comments": [],
"created": "2023-01-17T00:21:32.663Z",
"sampleData": false,
"stripeClientId": "cus_NFTM1mAFkgtfUI",
"notes": null,
"notifyOnCreate": null,
"contacts": [
{
"id": "63d431ab3813ca3d0789d2cc",
"accountId": 10016,
"clientId": "63c5ea0c840e3207033931b5",
"clientPortalUserId": -66,
"firstName": "Jeffrey",
"lastName": "Marna",
"role": null,
"phone": null,
"email": "geoff.mina@withmoxie.com",
"mobile": null,
"notes": null,
"defaultContact": true,
"invoiceContact": false,
"portalAccess": true,
"importRecordId": null,
"sampleData": 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.

Did this answer your question?