Tutorial

Webhooks & API

Integrate ComplyPost with your existing systems using webhooks and the REST API. Get real-time notifications and programmatic access to your letter data.

Setting Up Webhooks

Webhooks let you receive real-time HTTP POST notifications when events occur in your ComplyPost organisation. This is useful for integrating with your CRM, practice management software, or custom workflows.

1

Navigate to Settings

Go to Settings in the sidebar and scroll to the Webhook Notifications section.

ComplyPost — Webhook Settings Section
Roseworth & Co
Field 1
Field 2
Field 3
Field 4
Field 5
Save
The Webhook Notifications section in Settings — available on Pro and Enterprise plans.

Note

Webhooks are available on Pro and Enterprise plans. Upgrade from the Billing page if you are on the free plan.

2

Add a webhook endpoint

Click Add Webhook and enter:

  • URL — The HTTPS endpoint that will receive webhook events.
  • Description — An optional description for your reference.
  • Events — Select which events should trigger this webhook.
ComplyPost — Add Webhook Form
Roseworth & Co
Field 1
Field 2
Field 3
Field 4
Field 5
Save
Configure a new webhook endpoint with your URL and selected events.
3

Save the signing secret

When you create a webhook, ComplyPost generates a signing secret. Copy and store this securely — you will use it to verify that webhook payloads are genuine.

Warning

The signing secret is only shown once when the webhook is created. If you lose it, you can rotate to a new secret from the webhook settings.

Available Events

You can subscribe to the following webhook events:

letter.received

A new letter arrives via email ingestion.

letter.classified

AI analysis completes for a letter.

letter.urgent

A high-priority letter or action required is detected.

letter.deadline_detected

A deadline or due date is found in a letter.

letter.delivered

Email delivery is confirmed by the recipient server.

letter.bounced

Email delivery fails or bounces.

batch.completed

All letters in a batch have been processed.

Verifying Webhook Signatures

Every webhook payload includes an X-ComplyPost-Signature header. Use this with your signing secret to verify the payload is authentic. ComplyPost uses HMAC-SHA256 for signing.

REST API

ComplyPost provides a full REST API for programmatic access to your data. Use the API to manage clients, upload letters, query deliveries, and more.

For complete API reference documentation, including endpoints, authentication, and request/response examples:

View our API docs →