Testing and sandbox

COMMITLY has no public sandbox. You develop and test against a real COMMITLY account.

Write calls change real data

POST, PATCH, PUT and DELETE calls act on the live data of the company behind your credentials. Not every check the app makes applies to the API, so change only data your integration created.

Test safely on a live account

• Start read-only. Build and verify all GET calls first.
• Tag what you write. Set external_source (for example "my-integration-test") and a recognisable external_id on every budget you create, and a clear reference prefix on invoices. That way you can find and remove your test data.
• Write to a scenario first. A scenario is a plan layer on top of the forecast: its budgets change only that scenario, not the forecast and not any other plan. Create a scenario for testing, and move to plan or forecast budgets once your integration works.
• Clean up. Delete test budgets by their external_id and test invoices by their reference.
• Always send a selector when deleting invoices. DELETE /invoices/ without reference, id or source_id deletes every invoice your credentials can see.

Sandbox for Enterprise

Enterprise customers can get a separate sandbox. Contact support@commitly.com.