This guide covers managing third-party partners who integrate with the poker engine via the Developer Integration API: partner lifecycle, API key management, webhook delivery monitoring, and global API settings.
Required feature toggle: developerApi must be enabled in Settings > Features for partners to use the API. The Developer API sidebar section is hidden while the toggle is off.
Navigation
Navigate to Developer API in the admin sidebar. The Developer API section has the following pages:
- Partners — list, create, approve/suspend/delete partners
- Settings — global defaults for the integration API
- Audit Log — record of partner API activity
- Webhook Deliveries — delivery history across all partners
- Documentation — embedded API reference
Partners
Partner Statuses
| Status | Meaning |
|---|---|
| Pending | Self-registered partner awaiting admin approval |
| Approved | Active partner with API access |
| Suspended | Access revoked; API keys will be rejected |
Listing and Filtering Partners
Navigate to Developer API > Partners. The list shows:
| Column | Description |
|---|---|
| Name | Partner organization name |
| Contact email address | |
| Status | Current status badge |
| API Keys | Count of keys created for this partner |
| Mapped Users | Count of player accounts linked to this partner |
| Last Activity | Relative time of most recent API call |
| Created | Date the partner account was created |
Use the search box to filter by name or email. Use the status dropdown to filter by Approved / Pending / Suspended.
Creating a Partner
Required permission: developer:manage
- Click Add Partner.
- Enter:
- Name (required, 3–100 characters)
- Email (required)
- Website URL (optional)
- Description (optional, up to 500 characters)
- Click Create Partner. The partner starts in Pending status.
Partner Actions
Required permission: developer:manage
| Action | Available when | Effect |
|---|---|---|
| Approve | Status is Pending | Marks partner approved; optionally generates an initial API key |
| Suspend | Status is Approved | Revokes access; all API keys are rejected |
| Reactivate | Status is Suspended | Restores access |
| Delete | Any status | Permanently removes the partner and all associated API keys, user mappings, and webhook subscriptions |
Partner Detail
Click a partner row (or the View button on mobile) to open the partner detail page. From here you can:
- Edit partner details (name, contact email, website URL, description, webhook URL, username provisioning policy)
- Manage API keys
- View mapped users
API Keys
Each partner can have multiple API keys. A key controls which operations the partner can perform.
Key Fields
| Field | Description |
|---|---|
| Name | Label for identifying the key |
| Scopes | Permissions granted to this key (see below) |
| IP Allowlist (one per line) | Optional list of IP addresses allowed to use the key |
| Rate Limit (requests/min) | Max requests per minute for this key |
| Expires At (optional) | Expiry date; the key is rejected after this date |
Available Scopes
| Scope | Grants |
|---|---|
user:create | Create/Manage Users |
user:read | Read Users |
auth:code | Generate Login Codes for SSO |
balance:read | Read Balances |
balance:write | Modify Balances |
webhooks:manage | Manage Webhooks |
Generating a Key
- Open the partner detail page.
- Click Generate New API Key.
- Select a name, scopes, and optional rate limit / IP allowlist / expiry.
- The credentials are shown once under Save Your Credentials. Copy and securely store them — they cannot be retrieved again.
Key Actions
| Action | Effect |
|---|---|
| Edit | Edit name, scopes, IP allowlist, rate limit, or expiry |
| Rotate Secret | Generate a new secret; the old value can remain valid for a configurable Grace Period (hours) (0–720) |
| Revoke | Permanently invalidate the key |
Webhook Deliveries
The system delivers event notifications to the partner’s configured webhook URL when subscribed events occur.
Navigate to Developer API > Webhook Deliveries. Filter by partner, event type, and status. Cards show Total, Delivered, Failed, and Pending.
Delivery List
Each delivery entry shows:
- Partner and event type
- Status (Delivered, Failed, or Pending)
- Attempts and next retry
- Timestamp
Retrying a Delivery
Click Retry on a failed delivery to re-send it.
Webhook Signing
Outgoing webhook payloads are signed with an HMAC signature so partners can verify their authenticity. The partner’s Webhook URL is set in Edit Partner.
Developer API Settings
Navigate to Developer API > Settings to configure global defaults.
Required permission: developer:settings
Registration
| Setting | Description |
|---|---|
| Allow self-registration | When enabled, partners can register through the public registration endpoint without admin intervention |
| Require admin approval for new partners | When enabled, self-registered partners start as Pending and must be approved before they can use the API |
Defaults
| Setting | Description |
|---|---|
| Default Scopes | Scopes automatically assigned to API keys when a partner is auto-approved (no manual approval required) |
| Default Rate Limit (requests per minute) | Requests per minute applied to new API keys (1–10,000) |
| Username Policy | How usernames are assigned when partners provision new users: Require username from partner, Generate from email, or Generate random |
Authentication Modes
| Setting | Description |
|---|---|
| Allow cookie mode (redirect-based SSO) | Partners can generate login codes that set session cookies on exchange. Best for redirect-based (server-side) integrations |
| Allow token mode (iframe/embedded SSO) | Partners can generate login codes that return JWT tokens on exchange. Best for iframe or embedded integrations |
Audit Log
Navigate to Developer API > Audit Log to view partner API activity. The Developer Audit Log captures the action, partner, target user, status, IP address, request ID, and timestamp. Filter by action or partner.
Required permission: developer:read
Related
- Settings — Features Tab — enable
developerApifeature toggle - Security Administration — audit logging and account security