Skip to content

Request a new service connector

POST
/api/v1/forge/connector

Dispatch a ConnectorForge build job and return a job_id to poll for status.

Authorizations

Request Body required

Request body for POST /forge/connector.

Attributes: service_name: The service to connect (e.g. ‘Wave Accounting’). additional_info: Optional extra context for the build.

object
additional_info
Any of:
string
service_name
required

Name of the service to build a connector for

string
>= 1 characters

Responses

202

Successful Response

Typed envelope for POST /forge/agent and POST /forge/connector (202).

object
data
required

Envelope returned on successful job submission (202).

Attributes: job_id: UUID of the queued forge job. status: Always ‘pending’ at submission time.

object
job_id
required
string
status
string
default: pending

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string