Skip to main content
HTTP API with Clay

Send or retrieve from any tool or database using a general API endpoint

Updated over 2 months ago

Introduction

This integration enables users to send or retrieve data from any tool or database using a general HTTP API endpoint. By leveraging Clay's HTTP API action, users can seamlessly connect to external services, fetch data, or push information to third-party systems. This flexible integration allows for custom data enrichment and manipulation within Clay workflows, enhancing the platform's capabilities for diverse use cases.
โ€‹
Quick video on how HTTP API works:


Troubleshooting Body Parse Issues:

Input

Name

Is Optional

Description

Type

Method

true

Type in the HTTP method of your call, e.g. GET (default), POST, PATCH, PUT, or DELETE

text

Endpoint

Enter the endpoint to send the requests to, e.g. https://httpbin.org/post

text

Query String (Optional)

true

Enter any query string parameters to set when making the API Request i.e. email -> [email protected]

object

Body

true

Enter the data body to include, e.g. {"email": "[email protected]", "name": "Sam"} When using column tokens in a value, keep the key in quotes, but do not wrap the value in quotes e.g. { "email": #{{email field}}, "name": #{{name field}} }

longtext

Headers (Optional)

true

Enter any header fields to set, e.g. {'API-key': 'asdf1234'}

object

Remove null & undefined values

true

Toggle this field if you want to remove any values that are undefined or null

boolean

Field Paths to Return

true

If used, we'll only return field paths referenced in this input. You can enter multiple field paths, separated by a comma. For nested parameters, use dot path notation (e.g. object1.object2.name). This field is primarily used for APIs with unpredicatable input length to pull only data you need.

text

Did this answer your question?