Review the included Bilty OpenAPI contract
Use docs/openapi.yaml as the packaged contract for integration design, while treating the live enabled routes and client scopes as authoritative at runtime. The guide follows the Help Centre standard: exact route, prerequisites, ordered steps, verification and operational boundaries.
What you’ll accomplish
Use docs/openapi.yaml as the packaged contract for integration design, while treating the live enabled routes and client scopes as authoritative at runtime. Bilty Management keeps drafts, issued records, public capability links, finance, integration events and audit evidence as connected but separately verifiable records.
How the workflow fits together
Create scoped API clients, use REST endpoints, idempotency, request logs and signed webhook delivery. Use the module's current status, permission checks, warnings and linked records to decide the next supported action. Where a downstream invoice, WhatsApp queue item, webhook, PDF, POD record or audit event applies, verify it separately.
Follow these steps
- Go to Bilty Management module → docs/openapi.yaml and open the relevant current record or configuration view.
- Review the displayed state and compare it with the explanation in this guide.
- Compare the live values with the workflow described in this guide: Use docs/openapi.yaml as the packaged contract for integration design, while treating the live enabled routes and client scopes as authoritative at runtime.
- Follow any linked record, status, public evidence, invoice, queue or audit entry rather than inferring that a downstream action happened.
- Use the related guides below for the operational action that changes the record.
Fields and decisions to review
Record, audit and evidence checks
Reopen the relevant Bilty record or register and confirm its identifier, current status, related parties, timestamps and connected evidence. Check the audit/compliance, payment, public-link, report, API, webhook or WhatsApp evidence that applies to this workflow rather than relying only on a success alert.
How to confirm it worked
Return to Bilty Management module → docs/openapi.yaml or the resulting register and verify that the stored state matches the intended action. For any downstream automation, confirm the downstream record or queue/log entry as a separate completion check.
Technical basis for this guidance
This guide was checked against config/routes.php; controllers/Bilty_api_v1.php; controllers/Bilty_management.php; models/Bilty_management_model.php; views/admin/api.php; docs/openapi.yaml. It documents only behaviour exposed or enforced by the supplied module; internal secrets, raw signature payloads and unsupported future workflow assumptions are intentionally excluded.
Controls, checks and common mistakes
- Do not place bearer tokens or webhook secrets in Help Centre screenshots, tickets or logs.
- Scopes, IP allowlists and rate limits should use least privilege.
- Webhook delivery is asynchronous and should be verified from queue/request evidence.