Automation
Automation
Automate Apiable two ways: the Platform API for programmatic management of products, plans, subscriptions, teams, and users, and webhooks for real-time event notifications.
You can automate Apiable two ways. Call the Platform API to manage your API program programmatically, and subscribe webhooks so Apiable notifies your systems when something changes. Use them together: a webhook tells you a subscription was created, and the Platform API lets you act on it.
How do I automate Apiable?
Two ways. The Platform API is a REST API you call to manage products, plans, subscriptions, teams, and users. Webhooks send a POST to your endpoint when an event happens, so you do not have to poll for changes.
| Approach | Direction | Use it to |
|---|---|---|
| Platform API | You call Apiable | Create, read, and update products, plans, subscriptions, teams, and users from your own code or CI. |
| Webhooks | Apiable calls you | Get notified in real time when a subscription, invoice, or scope grant changes, without polling. |
What can the Platform API manage?
The Platform API is a REST API over your API program. It exposes products, plans, subscriptions, teams, users, companies, and documentation as JSON resources you read and update over HTTP. The full reference lists every endpoint and field.
| Resource | What you manage |
|---|---|
| Products | The API products in your catalog. |
| Plans | The plans developers subscribe to, and their documentation. |
| Subscriptions | Developer subscriptions, including approve and reject. |
| Teams | Consumer teams and their members. |
| Users | Developer accounts, including approve and reject. |
Read the complete list of endpoints, request bodies, and responses in the Platform API reference.
When should I use webhooks instead?
Use webhooks when you want to react to a change as it happens rather than poll for it. Apiable posts a signed payload to the URL you configure the moment an event fires, such as a new subscription or an approved scope grant.
Webhooks carry the event type and the subject of the event. You subscribe each webhook to the specific events it should receive, and Apiable signs every delivery so you can verify it came from Apiable. See Webhooks to configure an endpoint.
How do the Platform API and webhooks work together?
A webhook tells you something changed; the Platform API lets you act on it. A common pattern is to subscribe a webhook to SUBSCRIPTION_CREATED, then call the Platform API to read the subscription and provision access in your own systems.
This pairing removes polling. You wait for the event, then make one Platform API call to fetch the current state, rather than scanning for changes on a schedule.
How do I keep my docs in sync from CI/CD?
Push your OpenAPI spec to Apiable from your pipeline. A ready-made GitHub Action, or a direct Platform API call, updates a plan's documentation on each deploy, so your portal's API reference matches your code.
The action authenticates with a Platform API credential scoped to apiable/cicd and updates a documentation entry by its id. See CI/CD documentation sync.
Where to next
Webhooks
Configure an outbound endpoint, choose the events to subscribe to, and verify Apiable's signed payloads.
Platform API reference
The REST reference for products, plans, subscriptions, teams, users, and webhooks.
CI/CD documentation sync
Push your OpenAPI spec to Apiable from your pipeline, with the Apiable GitHub Action.