API reference
API Explorer
Browse the WarnFire API contract and test requests from your browser.
The explorer below uses the public OpenAPI document , generated from WarnFire’s source-of-truth contract with service-operation routes, provider callbacks, and their private component definitions removed.
Use production credentials carefully. “Try it out” sends a real request to the production API. Mutating operations can create, update, or delete production data. Authorization is kept only in this browser tab and is not persisted by the explorer.
Before you begin
No credential is required to browse schemas. To send a request, obtain the credential required by that operation and choose a safe production record or a disposable test record. For Events API requests, create a service and its first integration key .
Send a request
- Select Authorize and enter the credential required by the operation.
- Expand the endpoint you want to call and select Try it out.
- Enter the required path values and request body.
- Review the generated request, then select Execute.
Verify it worked
Confirm that the explorer shows the expected HTTP status and response body. For a mutating request, also confirm the intended record changed in WarnFire and that no unrelated record changed.
Next steps
Read API and automation before placing the same request in a script, scheduled job, or long-running integration.