Sign In
Sign Out

Storage & Hooks

Storage & Hooks lets you temporarily store API events and forward those events to your own webhook endpoint.

Temporary Event Storage​

Temporary event storage is configured per workspace and per API family. When enabled, events can be browsed in the Dashboard. Stored events are scoped by workspace and API key, so the event list can show all workspace events or only events generated by a selected key.

Events​

The Events view displays recent stored API events. Use filters to narrow the list by API family or API key. Attachments, where available, are opened through time-limited links.

Hooks​

Hooks forward stored API events to an HTTPS endpoint that you control. A hook subscribes to selected API families and receives event payloads after matching requests are processed.

Registering a Hook​

  1. Enable temporary event storage for at least one API family.
  2. Open the Hooks view.
  3. Add an HTTPS webhook URL.
  4. Confirm the subscription if required by the receiving service.
  5. Send a test API request and verify that the event is delivered.

Storage API Paths​

Storage API routes live under /storage, not under the Dashboard API path.

GET /storage/workspace/{workspaceId}/status
PATCH /storage/workspace/{workspaceId}/status
GET /storage/workspace/{workspaceId}/events
GET /storage/workspace/{workspaceId}/apikey/{apiKeyId}/events
GET /storage/workspace/{workspaceId}/hooks
POST /storage/workspace/{workspaceId}/hooks

Permissions​

Users need workspace permissions to manage storage and hooks. API keys used for backend access must have a role that allows the requested storage or event operation.