Webhook Events

Help Center/API & Webhooks
API & Webhooks5 min read

Receive real-time notifications for claim events.

Webhooks let you receive real-time notifications when events happen in ClaimPort.

Setting Up Webhooks

Step 1: Add Endpoint

  1. 1.Go to Settings > Webhooks
  2. 2.Click Add Endpoint
  3. 3.Enter your webhook URL
  4. 4.Select events to subscribe to
  5. 5.Click Save

Step 2: Verify Endpoint

We'll send a test event to verify your endpoint:

{
  "type": "webhook.test",
  "timestamp": "2024-01-15T10:00:00Z"
}

Respond with HTTP 200 to confirm.

Available Events

Claim Events

  • claim.created - New claim submitted
  • claim.updated - Claim details changed
  • claim.assigned - Claim assigned to agent
  • claim.status_changed - Status updated
  • claim.approved - Claim approved
  • claim.denied - Claim denied
  • claim.closed - Claim closed

Message Events

  • message.received - Customer message received
  • message.sent - Message sent to customer

Order Events

  • order.synced - Order imported/updated

Webhook Payload

All webhooks include:

{
  "id": "evt_123abc",
  "type": "claim.created",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": {
    "claim": { ... }
  }
}

Verifying Webhooks

Each webhook includes a signature header:

X-ClaimPort-Signature: sha256=abc123...

Verify using your webhook secret:

const crypto = require('crypto');
const signature = crypto
  .createHmac('sha256', webhookSecret)
  .update(payload)
  .digest('hex');

Retry Policy

Failed webhooks are retried:

  • 5 minutes after failure
  • 30 minutes after second failure
  • 2 hours after third failure
  • 24 hours after fourth failure

After 5 failures, webhook is disabled.

Best Practices

  1. 1.Respond quickly - Return 200 within 30 seconds
  2. 2.Process async - Queue events for processing
  3. 3.Handle duplicates - Events may be sent multiple times
  4. 4.Verify signatures - Always verify webhook authenticity
  5. 5.Monitor failures - Set up alerts for webhook failures

Still have questions?

Our support team is here to help you.

Contact Support