BRIDGE DEVELOPER PLATFORM

Custom Provider API

Connect your own website, game backend, CRM, store, or private service to Bridge. Push entitlement state for a Discord user and reuse it for role automation, Rule Engine conditions, or Network Verification.

Available on Bridge Pro and NetworkAPI keys are server-scoped, hash-only, rate-limited, and owner-managed.

Authentication

Create a credential from Dashboard → Plugins → Custom Provider API. The full brgpk_... secret is shown once. Keep it in server-side secret storage and send it as a Bearer token.

Authorization: Bearer brgpk_your_secret_here

Least-privilege permissions

READ

`entitlements:read`

Read a Discord member's entitlement snapshot without permission to change it.

WRITE

`entitlements:write`

Push single or bulk entitlement updates without permission to read snapshots.

A credential can be read-only, write-only, or read + write. A valid key that calls an endpoint outside its assigned scope receives 403 Forbidden; invalid or revoked keys receive 401 Unauthorized.

Check readiness

GET /api/provider/v1/health
Authorization: Bearer brgpk_...

The readiness response reports the server-scoped provider configuration, the calling credential's scopes, and which read/write capabilities are currently available.

Set an entitlement

POST /api/provider/v1/entitlements
Content-Type: application/json
Authorization: Bearer brgpk_...

{
  "user_id": "123456789012345678",
  "entitlement_key": "member",
  "active": true,
  "event_id": "customer-493-membership-v8",
  "metadata": {"plan": "gold"}
}

Use active: false when the member no longer qualifies. Reusing the same event_id makes network retries safe without applying the same mutation twice.

Bulk synchronization

POST /api/provider/v1/entitlements/bulk
Content-Type: application/json
Authorization: Bearer brgpk_...

{
  "batch_id": "membership-sync-001",
  "updates": [
    {"user_id":"123456789012345678","entitlement_key":"member","active":true,"event_id":"member-123-v9"},
    {"user_id":"223456789012345678","entitlement_key":"member","active":false,"event_id":"member-223-v4"}
  ]
}

Bridge accepts up to 500 updates in one bounded bulk request, applies accepted changes atomically in PostgreSQL, and queues targeted reconciliation once per affected Discord user.

Read an entitlement

GET /api/provider/v1/entitlements/123456789012345678?entitlement_key=member
Authorization: Bearer brgpk_...

Operational limits

120 weighted request units per minute per API key.
32 KB maximum single-update body.
256 KB maximum bulk body and 500 updates per request.
8 KB maximum metadata object and four metadata nesting levels.
Up to five active API keys per Discord server.

For 429 responses, honor Retry-After. For transient network/5xx failures, retry with the same event or batch identifiers.

Security model

✓ Full secrets are shown only at creation ✓ PostgreSQL stores SHA-256 hashes, not plaintext keys ✓ Key creation/revocation is Discord-server-owner only ✓ Every credential is locked to one Discord server ✓ Read/write scopes support least-privilege services ✓ Accepted writes trigger targeted reconciliation

Need deployment examples?The packaged PROVIDER_API.md and INTEGRATIONS_SETUP.md include cURL, JavaScript, Python, rotation, retry, and provider setup guidance.

Open Bridge Documentation