Migrating from Legacy Webhooks | Parallel Developer Documentation

Version: Current – v2.x

Overview

This guide is intended to be used by existing partners who migrated to our V2 Case Management APIs but rely on legacy per-client webhooks.

All new partners use modern webhooks by default and should refer to the Getting Started guide.

Deprecation Warning

We will sunset legacy per-client webhook support on December 1st, 2024.

Our legacy, per-client webhooks do not support "Case Management" specific events. Configuring your endpoint as a "modern" webhook will allow your systems to react to changes to risk match resolution, record status changes, and record archival. Additionally, modern webhooks aren't client-specific, so you'll receive events even for PRM records that are not associated with a specific client.

Migration

Overview

Migrating from legacy webhooks to modern webhooks is a two-step process:

  1. Create & test new Webhook(s)
  2. Delete legacy Webhook URL(s)

Considerations

If your endpoint will "no-op" on events that it doesn't explicitly handle, migrating your webhook configuration should take less than 10 minutes. If your endpoint will return 4xx or 5xx status codes for events it doesn't explicitly handle, you should implement handlers for the new events before migrating.

You will receive duplicate webhook events if both modern webhook(s) and legacy client-specific webhook(s) are enabled concurrently. Please ensure that your system can tolerate receiving duplicate events or plan to delete any legacy webhook URL(s) promptly.

Detailed Steps

  1. Check for Legacy Webhooks – Confirm which client(s) have legacy webhook(s) configured on your "Integrations & Exports" page under "JavaScript Clients."
  2. Create a new Webhook – Further down on the same page, under "Webhooks," click "+ Add Webhook" to create a new webhook. You can use the same URL as the legacy webhook(s), but modern webhooks will receive additional events.
  3. Test the new Webhook – Test your new webhook using the Send Test Payload button. Additionally, you can also test sample payloads for specific webhook events using a tool like Postman.
  4. Delete Legacy Webhook(s) – After verifying your endpoint can receive and handle events correctly, delete any legacy Webhook URL(s) configured under "JavaScript Clients."

Additional Events

After migrating, your configured endpoint(s) will receive notifications for all supported events, including six new "Case Management" specific events. As part of your migration, please ensure your new implementation handles the events listed below.