Custom API Action
Make a custom, authenticated HTTP call to the SmartRecruiters API.
Options
Field | Definition | Type | Required |
---|---|---|---|
Request Type |
These are the supported HTTP request methods, or HTTP verbs, in a custom API call (see HTTP request methods).
|
Dropdown |
TRUE |
Input
Field | Definition | Type | Required |
---|---|---|---|
Relative URL |
The URL address of the web server that you're attempting to call. Specify the relative URL as /{insert_remaining_URL}. You can specify query parameters in the relative URL using "?", or specify the query parameters as an object key pair in the Query input.
For example, for the SmartRecruiter API endpoint, https://api.smartrecruiters.com/user-api/v201804/access-groups the relative URL is /user-api/v201804/access-groups. |
Text |
TRUE |
Query | Specify any additional query parameters that should be included in object format (key value pairs). |
Object |
FALSE |
Headers | Specify any headers required in addition to authorization or content-type (these are already handled by this connector). |
Object |
FALSE |
Body | Specify a request body in JSON format. Only available for POST, PUT, and PATCH requests. |
Object |
FALSE |
Output
Field | Definition | Type |
---|---|---|
Response |
||
Status Code |
Result of the operation. The connector returns an HTTP status code that indicates whether the action taken by the card succeeded or failed. For example:
For a full list of possible status codes, see HTTP status codes. |
Number |
Headers |
Detailed context for the status code, unrelated to the output body. Response headers depend on your selected HTTP request option. Not all headers are response headers. This is similar to {"Content-type":"application/json"}. |
Object |
Body |
Data returned from your selected HTTP request. For example, the data from a GET request. |
Object |