API Reference

Client closed

webhook
clientClosed

Triggered when a client's status becomes Closed. The payload contains
the full Client resource.

Note the timing. Closing an ACTIVE client is deferred to a nightly job
so the closure aligns with month end, which means this event can arrive
up to a month after the closure was requested. PROSPECT and ADHOC
clients close immediately.

It also fires for closures that originate in a connected
practice-management system rather than in Socket.

Payload

Webhook envelope for client events. The payload field contains the full
Client resource, exactly as GET /api/v1/clients/{client} returns it.

string
enum
required

The client event type that triggered the webhook

Allowed:
payload
object
required
string
required
length between 16 and 16

Random 16-character string for replay detection

date-time
required

UTC timestamp of when the webhook was created (ISO 8601)

Response
200

Webhook received successfully

Updated 4 days ago

Did this page help you?
LoadingLoading…

Updated 4 days ago

Did this page help you?