Skip to navigation

Get HTTP action

View as Markdown

Returns one HTTP action by its id. Secrets come back redacted.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

The id of the HTTP action, as returned when it was created or listed.

Response

The HTTP action
idstringOptionalRead-only
Unique identifier of the HTTP action, assigned by the server.
signatureobjectOptional

The action’s callable contract: its name, description, input arguments and result schema. Required.

connector_idstringOptionalformat: "uuid"

Connector that supplies the base URL and authentication for the request. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).

methodenumOptional

HTTP method the action calls. One of: GET, POST, PUT, DELETE, PATCH. Required on create.

Allowed values:
pathstringOptional

Path appended to the connector’s base URL, not a full URL. Must start with a slash and contain no query string. Use {{{variable}}} for path parameters.

query_paramslist of objectsOptional
Query parameters appended to the request URL. Up to 250.
headerslist of objectsOptional
Request headers. Up to 250.
body_benderobjectOptional
Request body as a Moveworks data mapper expression. An update that includes this field replaces the whole body.
file_benderobjectOptional

Files sent in the request, as a Moveworks data mapper resolving to {argument_name: File | File[]}, where File is {filename, location}. Available to body_bender under the file keyword.

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

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error