Gateways Reference
Gateways are registered platform services that scripts can call. The "gateway" property in a script definition names the gateway; most use PascalCase, and the platform resolves it to a Spring bean by lowercasing the first letter and appending Gateway.
JSON "gateway": "CompanyRegister" → Spring bean: companyRegisterGateway
See Gateway Scripts for how to wire gateways into script definitions.
Calls made through gateways to external services count against per-tenant rate limits. When a limit is reached the platform returns HTTP 429 and the calling script or import stops. See External Service Limits for configuration and the usage endpoint.
Function gateways
Function gateways enrich an object by returning structured data that is written back to the object's fields.
| Gateway name | Spring bean | Purpose |
|---|---|---|
Echo | echoGateway | Reflects input parameters back as output — useful for testing |
Ai | aiGateway | Extracts structured field values from free-form text using Gemini |
DocumentTriage | documentTriageGateway | Classifies a document and generates a title using Gemini |
MarkdownConversion | markdownConversionGateway | Converts a PDF to Markdown via Google Document AI |
Invoice | invoiceGateway | Extracts structured invoice data from a PDF via Google Document AI |
AddressSearch | addressSearchGateway | Looks up a Dutch address by postal code and house number |
CompanyExtract | companyExtractGateway | Fetches an official company extract PDF (NL only) |
CompanyRegister | companyRegisterGateway | Enriches an object with company data from KvK (NL) or Companies House (GB) |
DataEnrichment | dataEnrichmentGateway | POSTs field values to a configurable HTTPS endpoint and merges the response |
See Function Gateways for the full reference.
Producer gateways
Producer gateways query an external source and return a result list. They do not modify any object.
| Gateway name | Spring bean | Purpose |
|---|---|---|
CompanySearch | companySearchGateway | Searches a national business register by company name |
companyLookupGateway | companyLookupGateway | Fetches the full company profile for a single company by composite key |
companyRelationsGateway | companyRelationsGateway | Directors, officers, and shareholders for a Dutch company (NL only) |
organizationTreeGateway | organizationTreeGateway | Corporate organisation tree for a Dutch company (NL only) |
See Producer Gateways for the full reference.
Consumer gateways
Consumer gateways call an external service and do not return a result.
| Gateway name | Spring bean | Purpose |
|---|---|---|
Mail | mailGateway | Sends a transactional email |
UserInvitation | userInvitationGateway | Creates a user invitation and sends a confirmation email |
Webhook | webhookGateway | Sends an HTTP request to a configurable endpoint |
DatastoreReplicator | datastoreReplicatorGateway | Replicates object data to an analytical datastore (BigQuery) in micro-batches |
See Consumer Gateways for the full reference.