Skip to navigation

Create HTTP connector

View as Markdown

Creates a HTTP connector and returns it with its server-assigned id and version.

Send the fields at the top level of the body. Don’t send id or version.num; version.change_description is required. Anything this HTTP connector refers to must already exist.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Request

This endpoint expects an object.
namestringRequiredformat: "^[a-zA-Z][a-zA-Z0-9_]+$"2-64 characters

Unique name of the connector, used by HTTP actions to refer to it. 2-64 letters, digits or underscores, starting with a letter. Cannot be changed, or reused after deletion.

base_urlstringRequired>=1 character

Base URL of the external API that every action path is appended to, for example https://api.example.com/v1. Must use https and a publicly reachable host unless the connector is routed through an on-premise agent.

versionobjectRequired
Document version. On update, send back the num from your last read.
basic_authobjectOptional
HTTP basic authentication with a username and password.
api_key_authobjectOptional
API key authentication, sent in a header or query parameter.
oauth2objectOptional
OAuth 2.0 authentication.
jwt_authobjectOptional
JWT bearer authentication signed with a private key you provide.
jwks_authobjectOptional
JWT bearer authentication signed with a key pair that Moveworks generates and rotates.
no_authobjectOptional
No authentication. Set to an empty object to send requests without credentials.
headerslist of objectsOptional
Headers added to every request made through this connector.
query_paramslist of objectsOptional
Query parameters added to every request made through this connector.
x509_optionsobjectOptional
Client certificate and private key for mutual TLS. Used only when both are set.
csrf_token_optionsobjectOptional
Settings for fetching a CSRF token before requests, for systems that require one.

Response

The created HTTP connector
idstringOptionalRead-only
Unique identifier of the HTTP connector, assigned by the server.
namestringOptionalformat: "^[a-zA-Z][a-zA-Z0-9_]+$"2-64 characters

Unique name of the connector, used by HTTP actions to refer to it. 2-64 letters, digits or underscores, starting with a letter. Cannot be changed, or reused after deletion.

display_namestringOptionalRead-only

Label shown for the connector in Tool Studio. Read-only; defaults to the name.

descriptionstringOptionalRead-only

Description of the connector as shown in Tool Studio. Read-only.

base_urlstringOptional>=1 character

Base URL of the external API that every action path is appended to, for example https://api.example.com/v1. Must use https and a publicly reachable host unless the connector is routed through an on-premise agent.

basic_authobjectOptional
HTTP basic authentication with a username and password.
api_key_authobjectOptional
API key authentication, sent in a header or query parameter.
oauth2objectOptional
OAuth 2.0 authentication.
jwt_authobjectOptional
JWT bearer authentication signed with a private key you provide.
jwks_authobjectOptional
JWT bearer authentication signed with a key pair that Moveworks generates and rotates.
no_authobjectOptional
No authentication. Set to an empty object to send requests without credentials.
headerslist of objectsOptional
Headers added to every request made through this connector.
query_paramslist of objectsOptional
Query parameters added to every request made through this connector.
x509_optionsobjectOptional
Client certificate and private key for mutual TLS. Used only when both are set.
csrf_token_optionsobjectOptional
Settings for fetching a CSRF token before requests, for systems that require one.
updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error