Call Integration

CallIntegration sends an HTTP request to a project’s deployed environment and returns the response. This allows triggering a project remotely via an HTTP call.

POST /o/{organisation_id}/projects/{project_id}/environments/call

Call Integration

cURL

curl --request POST \
  --url https://platform.versori.com/api/v2/o/{organisation_id}/projects/{project_id}/environments/call \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "urlPath": "<string>",
  "headers": {},
  "query": {},
  "body": "aSDinaTvuI8gbWludGxpZnk="
}
'

200

{
  "status": 123,
  "headers": {},
  "body": "aSDinaTvuI8gbWludGxpZnk="
}

Authorizations

bearerTokencookie

Authorization · string · header · required

Bearer token authentication used by the Versori Platform. External consumers must provide an API key, however internal consumers must provide a JWT id_token issued by our IdP.

Path Parameters

organisation_id · string<ulid> · required

project_id · string<ulid> · required

Query Parameters

project_env · string

Body

application/json

An HTTP request to send to a project's deployed environment.

urlPath · string · required

The URL path to call on the integration.

method · enum<string> · required

The HTTP method to use for the request.

Available options: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS

headers · object

HTTP headers to include in the request.

Show child attributes

query · object

Query parameters to include in the request.

Show child attributes

body · string<byte>

The request body as a base64 encoded string.

Response

200

application/json

OK

The HTTP response returned from a project's deployed environment.

status · integer · required

The HTTP status code of the response.

headers · object · required

HTTP headers returned in the response.

Show child attributes

body · string<byte> · required

The response body as a base64 encoded string.