Custom API Action

Make a custom, authenticated HTTP call to the Airtable API.

Important Note

This action is unlike other Airtable cards. Refer to Airtable API.

Methods

These are supported HTTP request methods, or HTTP verbs, in a custom API call (see HTTP request methods).

Field Definition Type Required
Request Type   Dropdown TRUE
GET

Retrieves data from a web server based on your parameters. This method requests a representation of the specified resource. If a request is successful, you receive a 200 (OK) response message with the requested content.

   
POST Sends data to a web server based on your parameters (for example, uploading a file). Multiple POST requests may result in a different outcome than a single POST, so you should be cautious about unintentionally sending multiple POST requests. If a request is successful, you receive a 200 (OK) response message.    
PUT Sends data to be stored at a specific location on a web server based on your parameters (for example, uploading a file). The difference between PUT and POST requests is that PUT is idempotent. This means that for successful requests, the result of a single PUT request is the same as many identical PUT requests. If a request is successful, you receive a 200 (OK), 201 (Created), or 204 (No Content) response message.    
PATCH Applies partial modifications to a resource on a web server based on your parameters. PATCH is not idempotent, which means that multiple PATCH requests could have unintended consequences. If a PATCH is successful, you receive a 200 (OK) or 204 (No Content) response message.    
DELETE Deletes the specified resource from the web server based on your parameters (if the resource exists). If a DELETE is successful, you receive a 200 (OK) response message.    

Input

Field Definition Type Required
Request
Relative URL

The address on the web server you are attempting to interact with. Relative URL means that you don't have to explicitly specify the protocol at the beginning of the URL (such as "http://"). This suggests to the web server that the interaction is occurring on the server (in this instance).

Example: https://api.airtable.com{{input.Request.Relative URL}}

String TRUE
Query

JSON object that determines the action taken at the URL.

Example: {"name":"something-urgent"}

Object or string FALSE
Headers

JSON object that determines the content type of the request. This will usually be similar to the following:

Example: {"Content-type":"application/json"}

Object FALSE
Body The data for your selected HTTP request. Object FALSE

Output

Field Definition Type
Response
Status Code

The result of your HTTP request. See HTTP status codes.

Number
Headers A 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 The data returned from your selected HTTP request (for example, the data from a GET request). Object

Related topics

Airtable connector

About the elements of Okta Workflows

Airtable API