Events

The Event Object

A Rutter Event represents an action that has ocurred in Rutter's system.

Currently only object_deleted events are exposed. These events represent instances where Rutter has determined that an object has been deleted on the underlying platform. Rutter in turn deletes the object from its system and emits an event.

Properties

idstring

ID of the event.

dataOptional

The data of the event.

resourcestring

The rutter object type.

typeenum

The type of the event.

Must beobject_deleted.

last_synced_atstring

The ISO 8601 timestamp for when this event occurred.

Endpoints

GET

/events

List Events

GEThttps://production.rutterapi.com/versioned/events

While the list events endpoint is generally supported for all platforms, specific event types have platform-level support detailed below. When a platform is not supported for an event type, an empty array is returned.

Event Type	Supported Platforms
`object_deleted`	`QuickBooks, Netsuite, and Xero`

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

typeenumqueryRequired

The type of event to list.

Must beobject_deleted.

cursorstringqueryOptional

The cursor to use for pagination. Use the value of next_cursor provided in a previous response.

limitintegerqueryOptional

The number of entities to return. Defaults to 500.

expandenumqueryOptional

Optionally, include raw external platform data when fetching data.

Must beplatform_data.

last_synced_at_minintegerqueryOptional

Used to filter objects with a last_synced_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

resourcesstringqueryOptional

Comma separated list of resources to query for. If omitted, all resources will be returned. A resource can be one of the following: ACCOUNT, ACCOUNTING_TRANSACTION, BANK_DEPOSIT, BANK_TRANSFER, CLASS, COMPANY_INFO, CURRENCIES, DEPARTMENT, ITEMS, JOURNAL_ENTRY, LOCATION, PAYMENT_TERM, PROJECT, SUBSIDIARY, TASK, TAX_AGENCY, TAX_RATES, ACCOUNTING_CUSTOMER, ACCOUNTING_CUSTOMER_REFUND, INVOICE, INVOICE_CREDIT_MEMO, INVOICE_PAYMENT, PAYMENT_METHOD, SALES_ORDER, SALES_RECEIPT, BILL, BILL_CREDIT_MEMO, BILL_PAYMENT, PURCHASE_ORDER, VENDOR, EXPENSE, BANK_FEED_ACCOUNT, BANK_FEED_TRANSACTION, BALANCE_SHEET, CASH_FLOW, INCOME_STATEMENT

Response Body

200

Example Response Body

JSON

1{
2  "events": [
3    {
4      "id": "594b751e-500c-45b1-8973-00c9dc7b4698",
5      "data": {
6        "id": "00000000-0000-0000-0000-000000000000",
7        "deleted_at": "2023-01-02T02:34:56.000Z"
8      },
9      "resource": "BILL",
10      "type": "object_deleted",
11      "last_synced_at": "2023-01-02T02:34:56.000Z"
12    }
13  ],
14  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
15}

Have questions?

Contact support for personalized guidance.

Contact support