Codehooks · AsyncAPI Specification

Codehooks Events API

Version 1.0.0

Asynchronous event API for Codehooks serverless backend hooks and queue workers. Covers CRUD lifecycle hooks triggered on collection document operations and asynchronous queue worker processing for named topics.

View Spec View on GitHub BackendDatabaseEventsHooksJavaScriptNoSQLQueuesServerlessWebhooksWorkersWorkflowsAsyncAPIWebhooksEvents

Channels

collection/beforeCreate

subscribe onBeforeCreate

Before document creation hook

Triggered before a new document is created in a collection. Allows validation or transformation of the incoming document data.

collection/afterCreate

subscribe onAfterCreate

After document creation hook

Triggered after a new document has been successfully created in a collection.

collection/beforeRead

subscribe onBeforeRead

Before document read hook

Triggered before a document is read from a collection. Allows modification of query parameters or access control enforcement.

collection/afterRead

subscribe onAfterRead

After document read hook

Triggered after a document has been read from a collection. Allows transformation or filtering of the returned data.

collection/beforeUpdate

subscribe onBeforeUpdate

Before document update hook

Triggered before a document is updated in a collection. Allows validation or transformation of the update data.

collection/afterUpdate

subscribe onAfterUpdate

After document update hook

Triggered after a document has been successfully updated in a collection.

collection/beforeDelete

subscribe onBeforeDelete

Before document deletion hook

Triggered before a document is deleted from a collection. Allows validation or prevention of the deletion.

collection/afterDelete

subscribe onAfterDelete

After document deletion hook

Triggered after a document has been successfully deleted from a collection.

queue/{topic}

subscribe onQueueJob

Queue worker job processing

Queue worker channel for processing asynchronous jobs. Worker functions registered for a topic receive jobs enqueued via the REST API or internal triggers.

Messages

✉

DocumentEvent

Document Event

Event payload containing a document from a Codehooks collection during CRUD lifecycle hooks.

✉

ReadEvent

Read Event

Event payload containing query parameters for a read operation on a Codehooks collection.

✉

DocumentUpdateEvent

Document Update Event

Event payload containing the update data and target document identifier during update hooks.

✉

DeleteEvent

Delete Event

Event payload containing the document identifier targeted for deletion during delete hooks.

✉

QueueJobEvent

Queue Job Event

Event payload for a queued job delivered to a worker function for asynchronous processing.

Servers

https

production https://{projectId}.api.codehooks.io/{space}

Codehooks serverless event endpoint