Webhooks
What is a Webhook?
A webhook is an automated HTTP POST that eCourtDate sends to the system when something happens. For example, when a text is delivered or a reply comes in. Think of it like a doorbell: instead of repeatedly checking whether someone is at the door (which is what polling the API would be), the doorbell rings immediately.
When would an agency need webhooks? When the case management system or internal tools should react in real time to eCourtDate events (such as logging delivery confirmations, flagging failed messages, or triggering follow-up actions), webhooks deliver that data the moment it happens.
Overview
Webhooks deliver real-time event payloads from eCourtDate to the application via HTTP POST requests. Instead of polling the API for updates, webhooks push data to the endpoint as events occur.
Data Flow
Use Cases
- Receive inbound messages: get a payload when a client sends a text to an agency phone or an email to an agency email address
- Track delivery status: get a payload each time the delivery status of an outbound text or email changes
Getting Started
Webhooks are configured in the eCourtDate Console under the Webhooks section. From there, create webhooks, assign them to agencies, configure endpoint URLs, and manage shared secrets for signature verification.
Supported Channels
| Channel | Sent when |
|---|---|
outbound_texts | The delivery status of an outbound text changes |
outbound_emails | The delivery status of an outbound email changes |
inbound_texts | An agency phone receives a text |
inbound_emails | An agency email address receives an email |
eCourtDate does not send webhooks for records such as clients, events, cases, payments, or checkins. To keep an external system current with those records, read them through the API. See Event Types for the payload of each channel.
Next Steps
- Configuration: set up the first webhook
- Security: secure the webhook endpoint
- Event Types: explore the payload structure
- Signature Verification: verify webhook authenticity
- Implementation Examples: build a complete webhook server