A ledger event handler
processes ledgerable events into ledger transactions. Creating a ledgerable event requires linking it to an existing ledger event handler. The ledgerable event must meet the conditions on the ledger event handler.
For every ledgerable event
that is created, there must be a ledger event handler
which matches following its conditions
field. On a match, we create a ledger transaction following the template defined in the ledger_transaction_template
field.
This is an Early Access feature.Features in early access may undergo changes in the future. Reach out to your customer success manager or support team in case of any questions.
Attribute | Description |
---|---|
id | Unique identifier for the Ledger Event Handler. |
name | Name for the Ledger Event Handler. |
description | An optional free-form description. |
conditions | An object in the form of: |
variables | An object in the form of:
There may be many variable names. They may be referred to from within the |
ledger_transaction_template | An object in the form of a Ledger Transaction. |
metadata | Additional data represented as key-value pairs. Both the key and value must be strings. See Metadata. |
live_mode | This field will be true if this object was created with a production API key or false if created with a test API key. |