POST
/
simulate
/
events

Event simulation is available to test webhook handlers and event processing logic.

Prerequisites

Some event types require specific endpoints to be called first:

  • attribute.* events: call POST /entities/:ent_id/attributes first
  • credit_score.* events: call POST /entities/:ent_id/credit_scores first
  • account.opened events: call POST /entities/:ent_id/connect first

Request Body

Entity Events

type
string
required

The type of event to simulate. One of attribute.*, credit_score.* or account.opened

entity_id
string
required

ID of the Entity.

Account Events

type
string
required

The type of event to simulate. Must be account.closed

account_id
string
required

ID of the Account.