HTTP API (Call an Osmos API)
Last updated
Last updated
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 latter. To see documentation on the former, see HTTP API (Osmos Calls Your API).
This Source Connector creates a secure HTTP endpoint for webhooks that you can send (POST) data to. Data sent to this endpoint can then be used as a source for Pipelines within Osmos.
Information needed:
Payload
Step 1: After selecting + New Connector, under the System prompt, click HTTP API
Step 2: Enter a Connector Name.
Step 3: Select Source Connector.
Step 4: Select Call an Osmos API
Build the schema for this HTTP endpoint using the provided schema builder shown below.
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 HTTP endpoint. |
Type | Define the type of each field. The field types will be used to enforce rules when you send data to this HTTP endpoint. |
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 HTTP endpoint. |
Delete | Deletes the field. |
Add Field | Adds another field to the schema. |
Create Schema | Saves the schema for this Connector and creates a URL for this HTTP Endpoint. |
1. Click Add Field for each additional field required in the Schema 2. Select Create Schema once you have built the schema. You will then be provided the URL and will be prompted to send data to this HTTP endpoint so you can save the Connector.
Send (POST) data from your source system to this Source Connector using the private URL created for this Connector, as displayed above. Data sent to this HTTP endpoint can then be used as a source for Pipelines within Osmos.
A minimum of 50 records must be provided to test and save this Source Connector. These records will be used when setting up an Osmos Pipeline with this Source Connector.
The connector can be deleted, edited and duplicated.
To save time, the connector can be duplicated. This new connector needs to be named and can be edited, as needed.
