Skip to main content
POST
Create an endpoint

Authorizations

Authorization
string
header
required

A workspace token in the Bearer scheme. The workspace must have the Connect app enabled.

Body

application/json

An endpoint as created: like EndpointInput, with the credentials its security or provider needs, which an update can leave out to keep the stored ones.

channel
enum<string>
required

http: documents are POSTed to the endpoint's uri. email: documents arrive as email attachments. Each channel has its own config.

Available options:
http,
email
Allowed value: "http"
slug
string
required

Unique in the workspace; part of the url, and the default name of an Invopop email address

Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
Example:

"suppliers"

workflow_id
string
required

The workflow each received invoice runs; it should include Connect's "Import document" step

config
object

The channel's own settings: HTTPConfig for http, EmailConfig for email. A secret left out on update keeps the stored one.

accept
enum<string>[]

Content types accepted; empty accepts any (email: PDF, XML, JSON and images)

Available options:
application/json,
application/xml,
text/xml,
application/pdf,
text/csv,
application/octet-stream,
image/jpeg,
image/png,
image/webp,
image/tiff,
image/heic
disabled
boolean

Stop receiving without deleting the endpoint

Response

The new endpoint

id
string
slug
string
channel
enum<string>
Available options:
http,
email
workflow_id
string
uri
string

Where senders reach the endpoint: the URL to POST documents to (http), or the address documents are sent to (email)

accept
string[]
disabled
boolean
created_at
string<date-time>
updated_at
string<date-time>
config
object

The channel's config as given, without secrets