Get details of a specific action, including its needs, gives, and a sample of the action.
params
provided in the request body.As such, this endpoint may need to be hit multiple times as needs are chosen by the user.alters_custom_fields
set to true
depends_on
array of another needcustom_field
set to true
GoogleSheetsV2API
API with the add_row
action, the first time you get the action you will get back these action_needs
:
spreadsheet
and worksheet
prefills, another call can be made to this endpoint.
This time, in the body of the POST
, we can include the selected values:
choices
array, then the value being chosen should come from that list.
Often, you will see this with boolean
fields.
For example, the SlackAPI
API’s direct_message
action contains the following need (irrelevant fields removed):
The app that the action belongs to.
The action to get details for.
The type of the action to get details for.
This can be:
write
: Actions that have side effects (such as sending an email or updating a spreadsheet)search
: Actions that return results (such as searching for a contact or getting a list of emails)read
, write
, search
, read_bulk
The Zapier account ID to use.
Account IDs available to the user can be listed using the Get Account List endpoint
ID of the authentication to use for the app.
Authentications available to the user can be listed using the List Authentications For App endpoint.
What kind of information to return with the action details.
List of:
action_needs
: Include the needs of the action. These are what are provided when running the action.action_gives
: Include the gives of the action. These are what the action returns when it runs.action_sample
: Include a sample of the action. Note: This will dramatically slow down the response from this endpoint. Only use it if you really need the sample.OK
The response is of type object
.