Custom API Action
Make a custom, authenticated HTTP call to the Proofpoint API.
This action is unlike other Proofpoint cards. Refer to Proofpoint API.
Options
Field | Definition | Type | Required |
---|---|---|---|
Request Type |
These are supported HTTP request methods, or HTTP verbs, in a custom API call (see HTTP request methods).
|
Dropdown | TRUE |
Input
Field | Definition | Type | Required |
---|---|---|---|
Request | |||
Relative URL |
URL address on the web server to which you are attempting to interact. Specify the relative URL as For example, for the Proofpoint API endpoint |
String | TRUE |
Query |
Specify any additional query parameters that should be included in object format (key value pairs).
Example: |
Object or string | FALSE |
Headers |
Specify any headers required in addition to authorization or content-type (these are already handled by this connector). This will usually be similar to the following : Example: |
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 are dependent on your selected HTTP request option. Note that not all headers are response headers. This will be usually similar to {"Content-type":"application/json"}. | Object |
Body |
Data returned from your selected HTTP request. For example, the data from a GET request. |
Object |