Webhooks

🔔 Webhook: Rule Match Notification

We use webhooks to notify your system when specific events occur—such as when a transaction is evaluated against a rule.

Once the transaction has been evaluated, our system sends a webhook to your configured endpoint. This webhook includes:

The match result: "MATCH" or "NOT_MATCH"
The IDs of related entities
The external transaction ID

📦 Example Payload

{
  "eventId": "f49d0b1d-4786-4a93-90f9-02cc673581d5",
  "rulesMatchResult": "MATCH",
  "entities": [
    "eus_4pmer37xzdg182gkv5",
    "pye_x83lr41o22v0dy5va2"
  ],
  "externalTransactionId": "pmt_94olbe128dv18k23yp"
}

📘 Field Descriptions

Field	Type	Description
`eventId`	`string`	Unique identifier for the webhook event.
`rulesMatchResult`	`string`	Outcome of the rule evaluation: `"MATCH"` or `"NOT_MATCH"`.
`entities`	`string[]`	List of related entity IDs involved in the evaluation.
`externalTransactionId`	`string`	Identifier of the transaction being evaluated.