Webhooks | Parallel Developer Documentation

Version: Current – v2.x

You can easily trigger automated downstream actions from your backend by listening to webhooks from your Case Management account. Webhooks are triggered for a variety of Webhook Events that occur within the Parallel Case Management system, including updates to individual and business records, when new risk matches are detected, or when risk matches are resolved.

Configuring Webhooks

You can create and manage webhooks from the Parallel dashboard:

  1. Log into your Parallel Markets account.
  2. Select your relevant business/account from the top-right dropdown.
  3. Navigate to the Integrations & Exports page (Settings > Integrations & Exports).
  4. Click the Add Webhook button in the Webhooks section.
  5. Enter your webhook URL.
  6. (Recommended) If you'd like to verify webhook authenticity, check the box titled Create cryptographic signing key to sign webhook bodies.
  7. Click Add Webhook to save the webhook configuration.

Request Details

Parallel will send an HTTP POST to the endpoint you specify whenever an event occurs (see the list of possible Webhook Events). Any configured webhook URL must accept a JSON POST request and return HTTP status 200 OK within 5 seconds. See the Webhook Events page for payload formats.

caution
If a successful response isn't received, we will automatically retry up to 3 additional times at 60 second intervals. Once three retries have failed, additional requests for the given event will not be sent.

Testing Webhooks

After configuring a webhook URL, click "Send Test Payload" to send a POST request from our servers, with "test" as the entity id. You'll see a success message for a 200 response or an error message with debugging information.

The body that is posted to your webhook will be:

{

"entity": {

"id": "test",

"type": "individual"

},

"event": "data_update",

"scope": "accreditation_status"

}

Deleting Webhooks

Webhooks will be delivered to the configured URL for all supported events. To stop delivery of webhooks, you can delete the webhook from the webhook settings. Once the webhook URL is deleted, webhooks will no longer be delivered to the specified URL.

Webhook Failure Notifications

If the third and final retry attempt fails to deliver, we will send an email to the "technical contact" specified in your "Profile" settings. The failure notification email contains (1) the endpoint that failed, (2) the number of failures in the last 15 minutes, (3) a description of the failure, and (4) the body of the most recently failed request. If no technical contact is present, we will email the user identified as the Primary Contact on your "Access" settings page.