Benny API Inc. Webhook Event Types

This is the list of event types that we currently send.
For guidance on how to listen to these events, take a look at Svix's guide to consuming webhooks.

ebt.balance.change

Emitted when a SNAP or EBT Cash balance is updated.

Example

JSON

{
  "payload": {
    "account_id": "acc_tkero8aci1idybyxiak8tx0a",
    "cash_balance": {
      "new_cash_balance_cents": 1000,
      "old_cash_balance_cents": 500
    },
    "snap_balance": {
      "new_snap_balance_cents": 5000,
      "old_snap_balance_cents": 4300
    }
  },
  "type": "ebt.balance.change"
}

ebt.link.client.success

Event emitted when the EBT account is successfully linked via the client SDK.

Example

JSON

{
  "payload": {
    "account_holder": {
      "address": "123 Main Street, Apt 1, New York, NY, 10012",
      "balances": {
        "cash": 0,
        "snap": 1023
      },
      "card_last_four": "1234",
      "last_transaction_date": "2024-01-23",
      "name": "John Smith"
    },
    "account_id": "acc_vn8ndtymq3bqlcot4tmo31gt",
    "external_id": "ba6bfca8-3bed-4b11-ba2d-4bad2a042593",
    "temporary_link": "temp_s76o1azllg3qe4j9hz2zm6ylt",
    "token": "tkn_n60unr8p8z0jnk4cqa4q5hi2"
  },
  "type": "ebt.link.client.success"
}

ebt.link.deactivated

Emitted when a link is manually deactivated or when login credentials have changed.

Example

JSON

{
  "payload": {
    "account_id": "acc_tkero8aci1idybyxiak8tx0a",
    "link_token": "tkn_n60unr8p8z0jnk4cqa4q5hi2"
  },
  "type": "ebt.link.deactivated"
}

ebt.transaction.change

Emitted when there is a new transaction or an update to a previous transaction.

Example

JSON

{
  "payload": {
    "account_id": "acc_tkero8aci1idybyxiak8tx0a",
    "transactions": [
      {
        "amount": 3600,
        "balanceType": "SNAP",
        "currencyCode": "USD",
        "date": "2024-01-05T00:00:00Z",
        "id": "txn_clr10cy59000k08l5e0wg5hrw",
        "transactionType": "FUND_LOAD"
      },
      {
        "amount": -500,
        "balanceType": "SNAP",
        "currencyCode": "USD",
        "date": "2024-01-04T00:37:56Z",
        "id": "txn_clr0zzpcj000108l52e7n6mgk",
        "merchant": "Berry's Bazaar",
        "merchantLocation": "456 Broadway, New York, NY",
        "transactionType": "PURCHASE"
      }
    ]
  },
  "type": "ebt.transaction.change"
}