HTTP API (Osmos Calls Your API)

Overview

There are two modes of operation for this connector. Either Osmos will call your API, or Osmos can generate an API for you to call. Put another way, either you have an API endpoint created, or you want Osmos to create an API endpoint for you. These two modes will be referred to as Osmos Calls Your API and Call an Osmos API respectively. This page is for the former. To see documentation on the latter, see HTTP API (Call an Osmos API).
This Connector will send data to a specified third party API.

Creating an HTTP API Destination Connector

Step 1: Click New Connector.
Step 2: Under the System prompt, click HTTP API.
Step 3: Provide a Connector Name.
Step 4: Select Destination Connector.
Step 5: Select Osmos Calls Your API

Building the Schema for the JSON Body of the Request

Parameter
Description
Field Name
Provide a field name for the output fields. These names will be used as the column names for the source data you send to this API.
Type
Define the type of each field. The field types will be used to enforce rules when you send data to this API.
Nullable
Check this box if the field is nullable. If the field is not nullable, you will be required to provide values for this field when sending data to this API.
Delete
Deletes the Field
Step 1: Click Add Field for each additional field required in the schema. Step 2: Select Create Schema once you have built the schema.
The schema cannot be changed after saving the Connector, so please confirm it is accurate before proceeding.

API URL

Specify the URL, including the port number if any, of the API that Osmos should be sending data to. For example, this could be http://example.com/api/v2:8824

HTTP Method

Select the HTTP Method that Osmos should use when sending the data to this API.

HTTP Headers

Specify the headers, if any, that Osmos should be using to send data to this API. Headers are often used for authentication, authorization, or declarations of what type of content you're sending. Headers have both a Name and a Value. For example, an authorization header might look like:
Name: Authorization
Value: qaX1SrppzSe1Y1qOOc08
Last modified 2mo ago