API and Webhooks

Acme Toolkit exposes a public REST API and a webhook system so you can integrate with other tools, push events in, and receive events out.

---

REST API#

A versioned REST API at /api/v1 lets external systems read and write your data.

• Authenticated with API keys you create in settings, passed as a bearer token
• Scoped permissions per key (for example, read-only on one resource, or read and write on another) so a key can only do what you allow
• Test and live keys, and the ability to revoke or expire a key at any time
• Consistent response envelope and clear error codes, with a machine-readable spec
• Resources cover the core records the product manages, plus webhook subscriptions

Inbound Webhooks#

Inbound webhooks let an external system trigger your automations.

• Each automation can expose an inbound webhook URL; an HTTP POST to it injects a custom event and runs the automation
• Useful for connecting tools that are not built in, for example firing an automation from a third-party form, a payment processor, or your own app

Outbound Webhooks#

Outbound webhooks push events to a URL you control.

• Subscribe to events such as a record created, a message received, or a payment completed
• Each delivery is signed so you can verify it came from your installation
• Retries on transient failures so a delivered event is not silently lost

For the full endpoint reference, request and response shapes, scopes, and event payloads, see the API reference that ships with the source.