Developers · API · Webhooks · Docs
Build on top of Portrex.
Mint API keys, subscribe to webhooks, and read the OpenAPI spec.
API keys
| Name | Prefix | Created | Last used | Scopes | |
|---|---|---|---|---|---|
Production server | pk_live_a8f2… | Jan 14, 2026 | 2 min ago | leads:readleads:writeprojects:read+1 more | |
Zapier connector | pk_live_4cd1… | Mar 2, 2026 | 14 min ago | leads:readleads:write | |
Internal reporting | pk_live_91be… | Apr 19, 2026 | 1 hr ago | leads:readprojects:readbilling:read+2 more | |
Sandbox / dev | pk_test_72aa… | Apr 28, 2026 | Yesterday | leads:read |
Webhook subscriptions
| Endpoint URL | Events | Status | Last delivery | |
|---|---|---|---|---|
| https://ops.acme.com/portrex/leads | 4 events | Healthy | 8 min ago | |
| https://hooks.zapier.com/hooks/catch/1184/abc… | 2 events | 3 failures | 2 hr ago | |
| https://internal.acme.com/audit/sink | 3 events | Disabled | 3 days ago |
API docsOpenAPI Specopenapi.yamlPostman Collectionportrex.postman.jsonTypeScript SDKnpm i @portrex/sdk
Example · POST /v1/leads
curl https://api.portrex.com/v1/leads \
-H "Authorization: Bearer pk_live_…" \
-H "Content-Type: application/json" \
-d '{"name":"Jane Doe","trade":"roofing"}'