Beta

Create a new connection specification using the Flow Service API

Last update: March 28, 2024

CREATED FOR:

  • Developer
NOTE
Self-Serve Sources Streaming SDK is in beta. Please read the sources overview for more information on using beta-labeled sources.

A connection specification represents the structure of a source. It contains information on a source’s authentication requirements, defines how source data can be explored and inspected, and provides information on the attributes of a given source. The /connectionSpecs endpoint in the Flow Service API allows you to programmatically manage the connection specifications within your organization.

The following document provides steps on how to create a connection specification using the Flow Service API and integrate a new source through Self-Serve Sources (Streaming SDK).

Getting started

Before continuing, please review the getting started guide for links to related documentation, a guide to reading the sample API calls in this document, and important information regarding required headers that are needed to successfully make calls to any Experience Platform API.

Collect artifacts

In order to create a new streaming source using Self-Serve Sources, you must first coordinate with Adobe, request a private Git repository, and align with Adobe on the details regarding the label, description, category, and icon for your source.

Once provided, you must structure your private Git repository like so:

  • Sources

      • Artifacts

        • {your_source}-category.txt
        • {your_source}-description.txt
        • {your_source}-icon.svg
        • {your_source}-label.txt
        • {your_source}-connectionSpec.json
Artifacts (file names)DescriptionExample
The name of your source. This folder should contain all artifacts related to your source, within your private Git repository.medallia
{your_source}-category.txtThe category to which your source belongs, formatted as a text file. Note: If you believe that your source does not fit in any of the above categories, please contact your Adobe representative to discuss.medallia-category.txt Inside the file, please specify the category of your source, like: streaming.
{your_source}-description.txtA brief description of your source.Medallia is marketing automation source that you can use to bring Medallia data to Experience Platform.
{your_source}-icon.svgThe image to be used to represent your source in the Experience Platform sources catalog. This icon must be an SVG file.
{your_source}-label.txtThe name of your source as it should appear in the Experience Platform sources catalog.Medallia
{your_source}-connectionSpec.jsonA JSON file that contains the connection specification of your source. This file is not initially required as you will be populating your connection specification as you complete this guide.medallia-connectionSpec.json
TIP
During the testing period of your connection specification, in place of key values, you can use text in the connection specification.

Once you have added the necessary files to your private Git repository, you must then create a pull request (PR) for Adobe to review. When your PR is approved and merged, you will be provided with an ID that can be used for your connection specification to refer to your source’s label, description, and icon.

Next, follow the steps outlined below to configure your connection specification. For additional guidance on the different functionalities that you can add to your source, such as advanced scheduling, custom schema, or different pagination types, please review the guide on configuring source specifications.

Copy connection specification template

Once you have gathered the required artifacts, copy and paste the connection specification template below to the text editor of your choice and then update the attributes in brackets {} with information relevant to your specific source.

{
  "name": "generic-streaming",
  "type": "generic-streaming",
  "description": "{DESCRIPTION}",
  "providerId": "521eee4d-8cbe-4906-bb48-fb6bd4450033",
  "version": "1.0",
  "attributes": {
    "category": "Streaming",
    "isSource": true,
    "documentationLink": "https://docs.adobe.com/content/help/en/platform-learn/tutorials/data-ingestion/understanding-streaming-ingestion.html",
    "uiAttributes": {
      "apiFeatures": {
        "updateSupported": false
      }
    }
  },
  "authSpec": [],
  "name": "generic-streaming",
  "permissionsInfo": {
    "view": [
      {
        "name": "StreamingSource",
        "@type": "lowLevel",
        "permissions": [
          "read"
        ]
      }
    ],
    "manage": [
      {
        "name": "StreamingSource",
        "@type": "lowLevel",
        "permissions": [
          "write"
        ]
      }
    ]
  },
  "providerId": "521eee4d-8cbe-4906-bb48-fb6bd4450033",
  "sourceSpec": {
    "attributes": {
      "authRequired": false,
      "uiAttributes": {
        "documentationLink": "http://www.adobe.com/go/understanding-data-streaming-ingestion-en",
        "isSource": true,
        "monitoringSupported": false,
        "category": {
          "key": "streaming"
        },
        "icon": {
          "key": "generic"
        },
        "description": {
          "text": "Generic Streaming For Authentication Testing 2"
        },
        "label": {
          "text": "Generic Streaming For Authentication Testing 2"
        },
        "frequency": {
          "text": "Generic Streaming"
        }
      }
    }
  },
  "exploreSpec": {
    "type": "StreamingConnection"
  }
}