Alpha: Webhooks

Current version: 0.1 (alpha) Warning: This is alpha functionality and may change or break without notice. If your integration stops working or you encounter issues, please contact Recras Support so we can help resolve it and keep you informed about changes.

Webhooks let your system react to changes in Recras in near real time. Standard ORM lifecycle events are emitted for many internal objects; we also provide a few custom events for common business actions.

Event semantics

  • postInsert: fired after a new record is created.

  • postUpdate: fired after an existing record is updated.

  • postDelete: fired after an existing record is deleted.

  • postSave: always fired together with postInsert or postUpdate. In other words: saving a model triggers postInsert/postUpdate and postSave.

Payload wrapper

Every webhook payload is wrapped in a small envelope with a version, the actual data, and a meta object (reserved for transport/context). The version only increases when the payload contract changes.

{
  "version": "0.1",
  "data": { /* event-specific fields */ },
  "meta": { /* transport or context fields */ }
}

Custom Events

Custom events do not contain ‘::’ in their name.

ORM Events

These events map to ORM lifecycle events and contain ‘::’ in their name.