Create HTTP Synapse
To create an HTTP synapse, go to the Custom Synapse tab in Synapse Studio. Click on the "Create New" dropdown and select "HTTP Synapse." Enter the Display name and API name for the synapse and choose the Authentication type. Optionally, you can upload an icon for the synapse and add additional metadata.
Click "Next" to proceed to the Test & Authenticate step. Here, you can test your HTTP endpoint with the selected Authentication type. Select the HTTP method, enter the endpoint, enter the request body and headers, and test. You can view the response preview in the section below.
Click "Next" to move to the review step and review your configurations. Click "Create," and your HTTP synapse will be created in the draft state.
Create Entity
To create an entity, select the "View Draft Status" option in the HTTP Synapse and click on the "New Entity" button. In the basic step, enter the Display name and API name for the entity. Optionally, you can add a description and tags.
Click "Next" to proceed to the Configuration step. Here, you can provide the endpoint, headers, body, variables, schema, record fields, and pagination type based on your requirements to configure your entity. The authentication type provided in the HTTP synapse will be used here to authenticate the endpoint.
In the testing tab, you can test your endpoint and view the response preview in the section below. You can use the "Use response for Schema" button to generate the schema based on the response.
Click "Next" to move to the review step and review your configurations. Click "Save," and your entity will be created. Once you are done with the configuration, you can publish the HTTP synapse by clicking the "Publish" button in the top bar.
Activate HTTP Synapse
HTTP synapses will be available along with other synapses in the right-side panel. Drag and drop the synapse onto the canvas and configure it by giving it a name and selecting the Authentication method. Click "Next." In the next step, authenticate your synapse by providing the credentials. Click "Next" and activate your synapse.
Create entity pipeline and Sync
Before creating the entity pipeline, check if your schema is configured correctly by going to the Schema Studio. Go to the Sync Studio and create the entity pipeline for your HTTP synapse. Go to the draft entity, configure any variables, and publish the pipeline. After that, click on the "More Actions" dropdown and perform a Resync. The entity pipeline will change to the running state after some time. Now you can go to the Data Studio and see that the entity you created now has the data returned from your API endpoint response.