🛠️

Webhooks

ActivePlatformMUSTFREE

What it does

Real-time event notifications with configurable endpoints. Register webhook URLs to receive instant notifications when classification completes, rates change, or compliance alerts trigger. Includes automatic retry with exponential backoff.

How to use it

Register a webhook

POST /api/v1/webhooks with your HTTPS URL and the events you want to subscribe to.

Store the secret

Save the webhook secret returned in the response for signature verification.

Handle events

Your endpoint receives POST requests with event data. Verify the signature before processing.

Manage webhooks

GET /api/v1/webhooks lists all registered webhooks. DELETE to remove them.

API Reference

GET/POST/api/v1/webhooks

Request

{
  "url": "https://yourapp.com/webhooks/potal",
  "events": [
    "classification.completed",
    "rate.changed"
  ]
}

Response

{
  "webhook": {
    "id": "wh_abc123",
    "url": "https://yourapp.com/webhooks/potal",
    "events": [
      "classification.completed",
      "rate.changed"
    ],
    "secret": "whsec_xxx...",
    "active": true
  }
}

cURL

curl -X POST https://potal.app/api/v1/webhooks \
  -H "X-API-Key: sk_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://yourapp.com/webhooks/potal","events":["classification.completed"]}'

Related Features

🛠️Webhook Retry

Automatic webhook retry with exponential backoff on failure

🛠️Email Notifications

Automated email alerts for rate changes, compliance, and usage

🛠️In-app Notifications

Real-time notification bell with read/unread status tracking

🛠️REST API

155+ API endpoints with consistent JSON responses

🛠️Error Handling

Structured error responses with codes, messages, and doc links

Having issues?

🐛 Report a Bug ❓ Ask a Question 💡 Suggest Improvement