What API integration capabilities are available?
Govform gives you a flexible HTTP client for connected journeys, plus platform APIs for discovering services, reading definitions and working with submissions, files, analytics and deployments.
You can bring external data into the service, send validated information out and connect your own reporting or automation tools. The request, response and point of execution can all reflect the process you are building.
Build the request your receiving system needs
| Capability | What you control |
|---|---|
| Methods and URLs | GET, POST, PUT, PATCH, DELETE and HEAD, with fixed or dynamic methods and templated URLs. |
| Headers and authentication | Required headers, API-key or bearer-token values, and client certificates where an endpoint requires mutual TLS. |
| Request payloads | Liquid templates that combine answers, calculated values and earlier action results into the required body. |
| Response formats | JSON, text, XML, CSV, form-encoded and binary responses, with results available to later content, conditions and actions. |
| Execution and recovery | Action triggers, conditions, request timeouts and configured failure alerts. |
| Prototype testing | Mock responses that let you build and check the journey before calling a real endpoint in QA. |
Connect your wider reporting and automation
- Submissions and evidence. Retrieve submitted data and access uploaded files through authorised platform endpoints.
- Service discovery and schemas. List library services and their metadata, then read field summaries or full Builder definitions through the service discovery API.
- Service insight. Fetch analytics events and journey analytics for your own reporting pipeline.
- Release information. Trigger service deployments and inspect deployed versions through permitted API operations.
- Scoped access. Configure API-key permissions and optional source-IP restrictions for the operations a connection needs.
For large evidence files, direct storage uploads or streamed downloads can suit the integration better than embedding files in a request. Base64 file payloads have a 25 MiB combined raw-file allowance, with encoding adding approximately one third; the receiving API may impose a lower limit.
Read about API actions and the Govform API.