How to use the HTTP Client action to make custom API requests

Keragon's HTTP Client lets you connect to any external API. Use it to retrieve data, update records, delete entries, or create new items in an app that Keragon does not integrate with yet, or when Keragon supports the app but not the specific action you need.

New: the HTTP Client now uses your existing app connections

When Keragon already supports the app, select that app's connection in the Auth tab and Keragon handles the authentication and the base URL for you. You only add the endpoint path (for example /chat.postMessage for Slack) and the body. No tokens to copy, no Authorization header to build, and secrets stay masked in the step output. This works in both workflows and agents.

Key Capabilities

  • GET Retrieve data from external services.
  • POST Create new records or submit data to external systems.
  • PATCH Make partial updates to existing records in other services.
  • DELETE Remove data from external applications.
  • PUT Completely replace or update existing records in external systems.

How to Use the HTTP Client in Keragon

Tip You can let Copilot build this step for you. Describe the request in the chat panel, for example "Add an HTTP POST step that posts a message to Slack using my Slack connection", or click How to configure this? inside the HTTP step for guided help.

  1. In the workflow editor, click the + button to add a new step.
  2. In the Apps tab of the drawer, search for HTTP and select it.
  3. Select the request method you need (GET, POST, PUT, PATCH or DELETE), based on the API documentation of the app you are calling.
  4. Open the Auth tab and choose how the request authenticates. See the tabs below for the two options.
  5. Open the Inputs tab and fill out the request.
    • URL The endpoint you are calling. If you selected an existing app connection, enter only the path, since the base URL is added for you.
    • Headers Any headers the API requires. Note that Content-Type is overridden by the Body type field, if provided.
    • Params URL query parameters to send with the request.
    • Timeout The number of milliseconds before the request times out.
    • Max redirects The maximum number of redirects to follow. Set it to 0 to follow none.
    • Body type The format of the request body.
    • Data The request body for POST, PUT and PATCH requests, built as an object or entered as raw JSON.
    • Throw error on failure True by default, which stops the workflow when the request fails. Set it to False to return the error response instead, so later steps can handle it.
  6. Click Test step to check the response, then click Save.
Existing app connection New authentication

Use this option when Keragon already supports the app but not the action you need. The HTTP step reuses your saved connection, so you do not have to find the token, add headers or type the base URL.

  1. Click the HTTP step in your editor.
  2. Open the Auth tab.
  3. Select the existing connection for the app, for example your Slack account. You will see a confirmation that the account selection was updated.
  4. Open the Inputs tab and enter only the endpoint path in the URL field, as listed in the app's API documentation.
  5. Leave the Authorization header out. Keragon adds the authentication for you and keeps the secret masked in the step output.
  6. Fill in the Data field based on the API requirements, then test and save the step.

Example

To post a message in Slack with a POST request

  1. In the Auth tab, select your Slack connection.
  2. In URL, enter /chat.postMessage.
  3. In Data, add the fields Slack expects, such as channel and text.
Was this article helpful?
0 out of 0 found this helpful

Articles in this section