Outbound Webhooks

PayMe → Your system

When a user qualifies for one of your cases, we immediately POST their information to your configured webhook endpoint.

Webhook delivery

MethodPOST
Content-Typeapplication/json
DestinationYour configured webhook URL
TimingImmediately after user qualifies
Timeout30 seconds (configurable)
RetriesConfigurable per partner (default: 0)

Authentication

We authenticate to your endpoint using whichever method your system requires. Tell us during onboarding and we'll configure it.

API Key

Custom header with your API key

X-API-Key: your-secret-key

Bearer Token

Standard Authorization header

Authorization: Bearer your-token

Basic Auth

Username and password

Authorization: Basic base64(user:pass)

HMAC

Signed request with shared secret

X-Signature: hmac-sha256-hash

Payload format

Every lead includes contact information, intake answers, and a _metadata block with case details. The LeadId is the canonical identifier — store it and include it when sending status updates back.

json
{
  "LeadId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "jane.doe@example.com",
  "phone": "+15551234567",
  "state": "CA",
  "dateOfBirth": "1985-03-15",
  "wasInjured": "yes",
  "diagnosisYear": "2022",
  "_metadata": {
    "response_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "mass_tort_slug": "roundup",
    "mass_tort_name": "Roundup Weedkiller",
    "partner_slug": "your-firm",
    "source": "in_app",
    "submitted_at": "2026-03-04T18:30:00.000Z"
  }
}

Important: Store the LeadId value. You'll need it when sending status updates back to us. This UUID is how we match your updates to the right user.

Expected response

Return any 2xx status code to acknowledge receipt. We log your response body and status code for debugging. Non-2xx responses are logged and retries fire if configured.

Custom payload mapping

If your system expects a different field structure, we configure the mapping for you — no work on your end. We support:

  • Field renaming firstName FirstName
  • Nested objects — e.g. PhoneNumber: { Number, CountryCode }
  • Value transforms — phone formatting, date normalization, boolean conversion
  • Static values — always-included constants like Source: "PayMe"

Provide your expected payload schema during onboarding and we'll handle the rest.