REST Connector

The REST Connector enables you to bring data into your story using REST APIs, allowing you to create, update, and manage items dynamically from external sources.

 

Authentication Methods

You can authenticate using one of the following methods:

• URL (select “None” in the dropdown)
• API Key
• Username and Password

Choose your preferred method from the dropdown on the Connect screen.

Use Cases

The REST Connector allows you to pull data from REST APIs into your story, enabling you to create, update, and delete items based on external data sources.

How to Use the Connector

After creating the connector, you will see the standard Connect screen where authentication is completed.

Once authenticated, click Next to proceed to the mapping stage.

Select Data Source
Choose the table or endpoint data you want to import and the category where the data will be stored. Use View Source Data to preview how the data is retrieved.

Map Data
Assign an External ID, which acts as a unique identifier for each item. It is recommended to use your own unique field rather than an auto-generated value to avoid incorrect data mapping or data loss.

Map fields to existing attributes or create new ones using (NEW), where you can define the attribute type.

Note: Tag Groups and Categories must exist before mapping. These can be created in Story Setup.

Apply Filters
Use filters to control which items are imported using the dropdown options.

Advanced SQL (Optional)
Enable Show Advanced SQL to edit queries, perform joins, and customize how data is imported. Once SQL is edited, you cannot return to the dropdown mapping interface.

Preview and Synchronization

Preview changes before importing. Blue rows indicate new items, while orange cells indicate modified values.

Click Synchronise to apply changes. A summary of updates will be displayed after completion.

Additional Options

Delete Records from Story (Default: True)
Ensures that records removed from the source are also deleted from the story.

Publish Connector
Once published, the connector cannot be edited and can be run by users with admin access. It uses the credentials of the user who published it.