Receive documents from external systems at public endpoints that trigger your workflows.
Invopop’s Connect app gives your workspace public endpoints where external systems can deliver documents over HTTP. Every file posted to an endpoint such a GOBL invoice or an XML document is validated, stored, and handed to the workflow of your choice, allowing you to ingest documents into your workflows without any polling or custom integration code.Each endpoint pairs a URL of the form https://connect.invopop.app/{workspace-id}/{slug} with a workflow. When a document arrives, Connect logs it and starts a workflow job that receives a link to the stored file.To get started you simply need at least one workflow to process incoming documents.
In the Console, open the apps directory by clicking the icon next to Apps in the sidebar. Find Connect in the list of available apps and click Connect to enable it in your workspace.
The Connect app in the apps directory
2
Launch the app
Once enabled, Connect appears in the sidebar under Apps. Click it to open the app, which has two tabs:
Endpoints: the URLs your workspace listens on.
Documents: a log of everything received.
3
Create an endpoint
Click New endpoint and fill in the form:
Slug: the last segment of the endpoint’s URL, unique within your workspace (lowercase letters, numbers, and hyphens). For example, invoices.
Workflow: the workflow to run for each document received at this endpoint.
Security: how senders must authenticate: None, Bearer token, Basic auth, or HMAC signature. Anything other than None is strongly recommended for endpoints that receive real data.
Accepted content types: optionally restrict the endpoint to specific formats (for example, only JSON). Leave empty to accept any content type.
Creating an endpoint
Click Save endpoint to finish.
4
Copy the endpoint URL
The new endpoint appears in the list with an Active status. Use the copy button in the URL column to grab its address, or open the endpoint to see the full Ingest URL and update its settings at any time.
The endpoint, live and ready to receive documents
5
Send a document
Any system that can make an HTTP request can now deliver documents to your workspace. Send a POST request to the endpoint URL with the file as the request body — for example, with a GOBL invoice saved as invoice.json:
If something is wrong with the request, the response says so: 401 when authentication fails, 415 when the content type isn’t accepted, 413 when the file is too large, and 422 when the payload is malformed.
Sending a binary file, like a PDF? Encode the body in base64 and add ?encoding=base64 to the URL. You can also add ?filename= to give the stored file a download name.
6
Track received documents
Every delivery shows up in the Documents tab, with its status, endpoint, content type, size, and the workflow job it triggered:
Done — the document was stored and its workflow job created.
Pending — the document was stored and is about to trigger its workflow.
Fault — the workflow could not be triggered; open the document to see the error.
The document log after the first delivery
Click a document to inspect it: the details panel shows the request headers (credentials are redacted), a preview of the payload, and a Download button to retrieve the original file.
Use the ⋯ menu at the end of each endpoint row to disable, re-enable, or delete an endpoint. A disabled endpoint rejects new deliveries, but its document history remains available in the log.
