Distributor API

Overview of Distributor API

Distributor API

Use this section to access distributor-scoped endpoints.

Getting Started

Use the Distributor API when managing partner organizations, memberships, billing codes, distributor-level analytics, and event delivery (callback URLs and signing secrets). For HTTPS callback behaviour, see the Outbound webhooks reference.

Authentication

All /api/v1/distributors/... endpoints require:

Header	Description
`SW-DISTRIBUTOR-ID`	Your unique distributor identifier
`SW-API-KEY`	Your secret API key

curl -X GET https://connect.safeweb.co/api/v1/distributors/analytics \
  -H "SW-DISTRIBUTOR-ID: your-distributor-id" \
  -H "SW-API-KEY: your-api-key"

Insights

Distributor Analytics

View distributor-level performance and activity metrics.

Billing Management

Billing Codes

List and create billing codes used across distributor workflows.

Billing Code Details

Retrieve info for a specific billing code.

Partner Management

Partners

List and create partner organizations under your distributor.

Partner Details

Retrieve, update, or offboard a specific partner.

Partner Memberships

Memberships

List partner memberships and invite new members.

Membership Details

Retrieve or delete a specific partner membership.

Webhooks

Create a webhook endpoint

Register a new HTTPS webhook URL for the authenticated distributor scope.

Generate signing secret

Create a new signing secret for callback verification.

Cycle signing secret

Rotate active and fallback secrets.

Deactivate webhook signing secret DELETE

Deactivates an active or fallback signing secret by id for the authenticated partner organization.

Distributor analytics GET

Retrieve distributor-level analytics and reporting metrics.

On this page

Distributor API Getting Started Authentication Insights Billing Management Partner Management Partner Memberships Webhooks