Help Center

Menu

Actions

Make Raw Request

Executes a custom request.

Configuration Fields

Do not throw an error on a 404 Response

An optional boolean. Treats 404 Hypertext Transfer Protocol (HTTP) responses as non-errors. The default value is false.

Input Metadata

Uniform Resource Locator

A required string. The path of the resource relative to the base URL.

Method

A required string. The HTTP verb to use in the request. The valid values are: GET, POST, PUT, PATCH, and DELETE.

Request Body

An optional object. The sent request body.

Output Metadata

Status Code

A required number. The HTTP status code of the response.

HTTP headers

A required object. The HTTP headers of the response.

Response Body

An optional object. The HTTP response body.

Delete Object By Identifier

Deletes a single object by its identifier.

Configuration Fields

Object Type

A required string. The object type to look up. For example, Users.

Input Metadata

Identifier Value

A required string. The identifier value of the object to delete.

Output Metadata

Identifier

A required string. The identifier of the deleted object.

Lookup Object By Identifier

Looks up a single object by its identifier.

Configuration Fields

Object Type

A required string. The object type to look up. For example, Users.

Allow criteria to be omitted

An optional boolean. If selected, the Identifier Value field becomes optional.

Allow zero results

An optional boolean. When selected, if the object is not found, an empty object is returned. If not selected, and the object is not found, an error is thrown.

Input Metadata

Identifier Value

A required string unless Allow criteria to be omitted is selected. The value for the unique search criteria in the Lookup Criteria configuration field.

Output Metadata

Object with the lookup result as a value.

Lookup Objects (plural)

Looks up a set of objects by a defined criteria list. It can be emitted in different ways.

Configuration Fields

Object Type

A required drop-down. The object type to look up. For example, Users.

Emit Behavior

A required drop-down. Defines the way result objects will be emitted. The valid values are: Emit all, Emit page, or Emit individually.

Input Metadata

Search Criteria

A required array of strings. The search terms are to be combined with the AND operator. For example:

 [{ fieldName: 'createdon', operator: 'gt', fieldValue: '2022-08-28T14:27:45Z'}, { fieldName: 'name', operator: 'eq', fieldValue: '"Alex"'}]

If Emit Behavior is set to Emit page, the following additional fields are added:

Page Number

A number. Indicates the index of the page to be fetched. The default value is 0.

Page Size

A number. Indicates the amount of objects per page. The value must be between 1 and 100 (inclusive). The default value is 100.

If Emit Behavior is set to Emit all, the following additional field will be added:

Emit only total count of results matching search criteria

A boolean. If true, only totalCountOfMatchingResults with the total amount of objects found by the search criteria will be emitted. The default value is false.

Output Metadata

For Emit All and Emit Page modes: An object with the key results that has an array as its value.

For Emit Individually mode: Each object fills the entire message.

If Emit only total count of results matching search criteria is set to true for Emit All mode: Only totalCountOfMatchingResults, with the total amount of objects found by the search criteria, is emitted.

Upsert Object

Updates or creates an object.

Configuration Fields

Object Type

A required drop-down. The object type to upsert. For example, Users.

Create or update existing object

A required drop-down. The valid options are Create new or Update existing.

Make GET request after object created/updated

An optional checkbox. Makes a GET request after the object is created/updated. If false, only the object identifier is emitted.

Input Metadata

Dynamically generated fields according to the chosen Upsert Schema.

Output Metadata

If Make GET request after object created/updated is true: Dynamically generated fields according to the chosen Upsert Schema.

If Make GET request after object created/updated is false: Only the object identifier is emitted.

Identifier

An optional string. The identifier of the upserted object.