{"article":{"id":19894107858578,"url":"https://keragonhq.zendesk.com/api/v2/help_center/en-us/articles/19894107858578.json","html_url":"https://help.keragon.com/hc/en-us/articles/19894107858578-How-to-use-the-HTTP-Client-action-to-make-custom-API-requests","author_id":18425913370002,"comments_disabled":true,"draft":false,"promoted":false,"position":0,"vote_sum":0,"vote_count":0,"upvote_count":0,"downvote_count":0,"section_id":18579494164242,"created_at":"2024-07-02T14:44:26Z","updated_at":"2024-07-02T16:02:29Z","name":"How to use the HTTP Client action to make custom API requests","title":"How to use the HTTP Client action to make custom API requests","source_locale":"en-us","locale":"en-us","outdated":false,"outdated_locales":[],"edited_at":"2024-07-02T16:02:13Z","user_segment_id":null,"permission_group_id":18473984347538,"content_tag_ids":[],"label_names":[],"body":"

Keragon's HTTP Client is a versatile feature that allows you to connect to external APIs. Whether you need to retrieve data, update records, delete entries, or create new items in an application outside Keragon's existing integrations or whenever Keragon does not support a specific action for an existing integration, the HTTP Client is your go-to solution.

\n

Key Capabilities

\n\n

How to Use the HTTP Client in Keragon

\n
    \n
  1. In the workflow editor, click the \"+\" button to add a new action.
    2. \n
  2. In the drawer that opens, search for HTTP and select it.
    3. \n
  3. From the list of the available triggering events, select the desired API operation (POST, GET, PUT, PATCH, DELETE) based on what you are trying to achieve.
    4. \n
  4. Fill out the fields of the HTTP action including the URL, Headers and Data based on the API docs of the app that you want to make this request.\n
      \n
    1. \nSpecify the URL: Enter the endpoint of the API you’re targeting.
      2. \n
    2. \nAdd Headers and Authentication: If the API requires headers or specific authentication (like API keys or OAuth tokens), add these in the respective sections.
      3. \n
    3. \nConfigure Data: For POST, PUT, and PATCH requests, you’ll often need to provide a request body. Enter this in the format required by the API.
      4. \n
    \n
    5. \n
  5. Click the \"Save\" to save your configuration.
    6. \n
\n
\n
\nNew authentication Existing authentication\n
\n
You can add a new authentication in your HTTP client to connect with third-party apps that are not yet supported by Keragon.\n
    \n
  1. Click the \"HTTP action\" in your editor
    2. \n
  2. Navigate to the 'Auth' tab in the drawer.
    3. \n
  3. Click 'Connect new account' and follow the steps to connect to the third-party app.
    4. \n
  4. In the inputs tab make sure that you have correctly set up the Authentication header\n

     

    \n
    \n

    Ensure that the Authentication header matches the format expected by the third-party app exactly. Pay close attention to both the Key name and the value for the header.

    \n

    For example, if an app requires authentication in the format:

    \n
    \"X-auth\": \"Bearer YOUR_TOKEN\"
    \n

    Then in Keragon you should:

    \n

    1. Enter 'X-auth' as the key name.

    \n

    2. Type 'Bearer', add a space, and then map the authentication from the 'Authentications' tab.

    \n

    Example

    \n

    Below is the Header configuration for Airtable in Keragon. Airtable requires the Authentication header to be in the format of:

    \n
    \"Authorization: Bearer YOUR_TOKEN\"
    \n

    Therefore, we entered 'Authorization' as the 'key name', typed 'Bearer', added a space, and then mapped the Airtable authentication from the 'Authentications' tab.

    \n

    \"Screenshot

    \n
    \n
    5. \n
  5. Configure the data part based on the API requrements
    6. \n
\n
\n

Example

\n

This is an example of using the HTTP client to make a POST request in Pipedrive for creating a new deal:

\n

\"Screenshot

\n
\n
\n
You can use an existing authentication from any app that you have integrated with Keragon. This is particularly useful in cases where Keragon supports an application but does not support a specific action. In such instances, you can utilize the HTTP client to facilitate it.\n
    \n
  1. Enter your key name in the header as required by the app for which you are making the HTTP request, and then click the 'Add' button.
    2. \n
  2. Click on the input field and select the 'Authentication' tab.
    3. \n
  3. Choose the authentication from an existing app that you have already included in the workflow.
    4. \n
  4. In the inputs tab make sure that you have correctly set up the Authentication header\n

     

    \n
    \n

    Ensure that the Authentication header matches the format expected by the third-party app exactly. Pay close attention to both the Key name and the value for the header.

    \n

    For example, if an app requires authentication in the format:

    \n
    \"X-auth\": \"Bearer YOUR_TOKEN\"
    \n

    Then in Keragon you should:

    \n

    1. Enter 'X-auth' as the key name.

    \n

    2. Type 'Bearer', add a space, and then map the authentication from the 'Authentications' tab.

    \n

    Example

    \n

    Below is the Header configuration for Airtable in Keragon. Airtable requires the Authentication header to be in the format of:

    \n
    \"Authorization: Bearer YOUR_TOKEN\"
    \n

    Therefore, we entered 'Authorization' as the 'key name', typed 'Bearer', added a space, and then mapped the Airtable authentication from the 'Authentications' tab.

    \n

    \"Screenshot

    \n
    \n
    5. \n
  5. Configure the data part based on the API requrements
    6. \n
\n
\n

Example

\n

This is an example of using the HTTP client to make a POST request in Pipedrive for creating a new deal:

\n

\"Screenshot

\n
\n
\n
"}}