Send API Request
Jake Rosenthal avatar
Written by Jake Rosenthal
Updated over a week ago

How to set up and use action

Sends an API request to an external system. Follow these steps:

  1. Add a Send API Request action: While editing a workflow, click the plus button between existing blocks. This will open a modal where you can select from Cassidy's pre-configured actions. Choose the Send API Request action to add it to your workflow.

  2. Rename the action (if needed): If you want to make the action more descriptive or easier to reference as a variable later, enter a new name.

  3. Enter "URL": In the "URL" field, enter the destination of the API request. You can hardcode the URL or use variables from previous steps or the trigger to dynamically set the URL.

    *Variables are inputs from the trigger, or outputs from previous steps

  4. Select "Method": Choose the appropriate HTTP method for your request, either GET or POST, depending on the API endpoint requirements.

  5. Add Headers: If the API requires specific headers, click the "+ Add Header" button. Fill in the "Key" and "Value" fields for each header. You can reference variables in the header values. Continue adding more headers as needed. If you make a mistake or need to remove a header, click the trash icon next to the corresponding key-value pair.

  6. Add Body (POST only): If you selected the POST method, you'll need to include the request body. The body will be formatted as a JSON object. Click the "+ Add Body Field" button and fill in the "Key" and "Value" fields for each body parameter. You can reference variables in the body values. Continue adding more body fields as required. If you need to remove a body field, click the trash icon next to the corresponding key-value pair.

Here's a sample of the type of output you can expect:

Did this answer your question?