Skip to main content

Custom Gateway

Verification Needed

This section describes the anticipated custom gateway pattern. Details may change. Verify with eCourtDate support.

Custom gateways use a webhook-based pattern to integrate eCourtDate with any messaging provider. This allows messages to be routed through any system that can receive HTTP requests.

How It Works

The custom gateway follows a three-step process:

  1. eCourtDate sends a request: An HTTP POST is sent to the gateway endpoint containing the message details.
  2. The gateway forwards the message: The endpoint processes the request and forwards the message to the chosen messaging provider.
  3. The gateway reports status: Delivery status is reported back to eCourtDate for tracking.

Webhook Payload

The following fields are anticipated in the webhook payload sent to the endpoint:

FieldTypeDescription
tostringRecipient address (phone number, email, etc.)
fromstringSender address
contentstringMessage body content
channelstringDelivery channel (e.g., sms, email, voice)
message_uuidstringUnique identifier for the message

Example Payload

{
"to": "+15551234567",
"from": "+15559876543",
"content": "Your court hearing is scheduled for March 15, 2026 at 9:00 AM.",
"channel": "sms",
"message_uuid": "msg_abc123def456"
}

Response

The endpoint should return an HTTP 200 status code to acknowledge receipt of the message request. A non-200 response may trigger retries or mark the message as failed.

Use Cases

  • Proprietary messaging systems: Integrate with internal or government-specific messaging platforms.
  • Aggregated messaging providers: Route through providers not directly supported by eCourtDate.
  • Custom routing logic: Implement the agency's own logic to determine how and where messages are delivered.

Setup

To configure a custom gateway, navigate to the gateway settings in the eCourtDate Console and provide the webhook endpoint URL.

For troubleshooting custom gateway issues, see Gateway Troubleshooting.