Simulate an Event - Method API Docs

curl https://dev.methodfi.com/simulate/events \
  -X POST \
  -H "Method-Version: 2024-04-04" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "credit_score.create",
    "entity_id": "ent_au22b1fbFJbp8"
  }'

const event = await method
  .simulate
  .events
  .create({
    type: "credit_score.create",
    entity_id: "ent_au22b1fbFJbp8"
  });

event = method.simulate.events.create({
  "type": "credit_score.create",
  "entity_id": "ent_au22b1fbFJbp8"
})

POST

simulate

events

curl https://dev.methodfi.com/simulate/events \
  -X POST \
  -H "Method-Version: 2024-04-04" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "credit_score.create",
    "entity_id": "ent_au22b1fbFJbp8"
  }'

const event = await method
  .simulate
  .events
  .create({
    type: "credit_score.create",
    entity_id: "ent_au22b1fbFJbp8"
  });

event = method.simulate.events.create({
  "type": "credit_score.create",
  "entity_id": "ent_au22b1fbFJbp8"
})

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

Account Events

curl https://dev.methodfi.com/simulate/events \
  -X POST \
  -H "Method-Version: 2024-04-04" \
  -H "Authorization: Bearer sk_WyZEWVfTcH7GqmPzUPk65Vjc" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "credit_score.create",
    "entity_id": "ent_au22b1fbFJbp8"
  }'

const event = await method
  .simulate
  .events
  .create({
    type: "credit_score.create",
    entity_id: "ent_au22b1fbFJbp8"
  });

event = method.simulate.events.create({
  "type": "credit_score.create",
  "entity_id": "ent_au22b1fbFJbp8"
})

Create a Transaction Create a Custom Credit Score

⌘I

​Prerequisites

​Request Body

​Entity Events

​Account Events

Prerequisites

Request Body

Entity Events

Account Events