Integration checklist
Check your scopes, request formats, and error handling before going live.
Before going live:
- Confirm the token is a Core organization token and has not expired.
- Confirm a scope exists for every resource your integration calls.
- Confirm each event is inside the scope’s event selection.
- Select only the response fields and associations the integration genuinely needs.
- Select every filter the integration sends; unselected filters are ignored.
- Configure row restrictions and test both an allowed and a disallowed record.
- For writes, enable both the write permission and each required action, input, and write-response field.
- Test pagination with more than 30 records.
- Store timestamps with explicit time-zone offsets, preferably UTC (
Z). - Handle
400,403,404,422, and429distinctly and log Brella request context without logging the token.
When a response seems incomplete, compare it with the scope in this order: readable fields, event selection, row restrictions, query fields, included associations, and the caller’s include parameter. That sequence explains most differences without changing the API request itself.