REST Sink

To create or update resource on the server you can use REST Sink as Destination that allows you to send your extracted or transformed data of any Integration to a configured API using HTTP Put and Post methods.

Step by Step to Sink Data to REST API

Step 1: Add Destination

Go to the "Add Destination" page to choose REST Sink as a destination.

Step 2: Configure the Destination

• URL: To call the API, enter the valid end point URL

• HTTP Method: HTTP methods tell server what should be done with the resource.

  • Use Post method to create a resource on the server

  • Use PUT method to updates the data that is stored in the server

• REST API endpoint can pass data within their request in three ways- Parameters, Headers and Custom Body

  • Headers: Here you can pass the parameters that are usually related to authorization

  • Parameters: They are the query string parameters that you can pass in Key and Value pair

Key	Value
Content_Type	application/JSON
Customer ID	1

• Custom Body: In custom body you can pass the data that you want to update or create at the server. Parameters in custom body usually submitted as JSON.

Note

You can also pass the parameters using {{{}}} curly braces in the Parameters, Headers, and Custom Body sections

• Authentication: When working with REST APIs you must remember to consider security from the start. By default it is inactive. You can enable authorization by clicking on the slider, select an appropriate authorization "Type" and then provide the requested credentials

Boltic supports the following API authorization methods -

Type	Dropdown to be Selected	Info to be Added
Basic Authentication	Basic Auth	Username and Password
API Key	API key	Provide the Key and Value

• API Type: You can send the data to API either in Batch or Event form

  • In Batch data is sent to API in batches of 1000 which is the default value

  • In event for each and every row there will be a sperate API call

• Retry attempts: The http request may fail because of many reasons such as timeout, server errors or rate limit. To handle the failed request you can select the numbers of retry attempts. Retry will be only attempted for timeouts, server errors or rate limit. It won't be attempted in case of 4XX error except 429 which is the error code for rate limit

Step 3: Test & Save

To validate data source configuration, click on the Test Connection, and determine whether the connection is successfully established or not.

Step 4: Publish Bolt

Click "Publish" and give a meaningful name and a add description to the bolt.

Scheduling

After successfully sinking data to the destination, you can click on the Schedule to run data continuously to a destination and repeat at a given time or interval.

Any Question? 🤓

We are always an email away to help you resolve your queries. If you need any help, write to us at - 📧 support@boltic.io