Connectors / Service / Confection

Confection is a web data platform that help businesses achieve control over data. (updated: 1643194333861)

Confection

Confection is a web data platform that helps businesses achieve control over data.

Overview

Confection uses innovative architecture to help businesses thrive in a privacy-first approach to their data. This architecture allows businesses to collect, store and distribute their data.

API INFO: The Base URL used for the confection connector is https://transmission.confection.io/{{YOUR_ACCOUNT_ID}}. More information can be found on their main API documentation (v1.0) site.

Authentication

IMPORTANT!: You will need to provide both Public and Private keys as operations in the Confection connectors vary in the key they use to authenticate with.

Within the builder, click on the Confection connector to display the connector properties panel. Select the 'Authentication' tab and click on the 'New authentication' button.

confection-auth

In the Tray.io authentication pop-up modal, name the authentication in a way that will easily identify it within a potentially large list. For example, whether it is a Sandbox or Production auth, etc.

Consider who/ how many people will need access to this authentication when choosing where to create this authentication ('Personal' or 'Organisational').

The second page asks you for your 'Account ID', 'Public key' and 'Private key' Confection authentication credentials.

confection-popup

In order to get these fields, head to the Confection dashboard. Click on the API keys tab on the far left.

confection-auth-step-1

This will allow you to retrieve the 'Account ID', 'Public key' and 'Private key'.

confection-auth-step-2

Once you have added these fields to your Tray.io authentication pop-up window, click the 'Create authentication' button.

Your connector authentication setup should now be complete.

Available Operations

The examples below show one or two of the available connector operations in use.

Please see the Full Operations Reference at the end of this page for details on all available operations for this connector.

Using the Raw HTTP Request ('Universal Operation')

As of version 1.0, you can effectively create your own operations.

This is a very powerful feature which you can put to use when there is an endpoint in Confection which is not used by any of our operations.

To use this you will first of all need to research the endpoint in the Confection API documentation v1.0, to find the exact format that Confection will be expecting the endpoint to be passed in.

Note that you will only need to add the suffix to the endpoint, as the base URL will be automatically set (the base URL is picked up from the value you entered when you created your authentication).

The base URL for Confection is: https://transmission.confection.io/{{YOUR_ACCOUNT_ID}}

For example, say that the 'List leads' operation did not exist in our Confection connector, and you wanted to use this endpoint. You would use the Confection API docs to find the relevant endpoint - which in this case is a GET request called: /leads.

More details about this endpoint can be found here.

confection-get-url

IMPORTANT!: To use the Raw HTTP Request connector you will to find from the dashboard above whether the endpoint requires either your Public or Secret Key to authenticate against. In this case, this endpoint requires the Secret Key, and therefore you will need to send this in the raw body.

So if you know what your method, endpoint and details of your authentication parameters are, you can list all leads with the following settings:

Method: POST

Endpoint: /leads

Body Type : Form-data : key: {{YOUR_PRIVATE_KEY}}``

Final outcome being: <Content type link TBD>

confection-raw-http-step-1
confection-raw-http-step-2

All Operations

Latest version:

1.1

Filter events by date

Return all leads between specified dates which contains any value in a given event.

Filter leads by date

Retrieve all leads updated between specified dates.

Filter leads by field

Retrieve all leads from an account which contains any value value in the specified field.

Filter leads by field and date

Return all leads between specified dates which contains any value of the given field.

Get event

Retrieve a specified event of a lead.

Get full lead

Retrieve all relevant fields for a specified lead.

List event names DDL

List events

Retrieve a list of events for a specified lead.

List leads

Retrieve a list of leads.

List leads DDL

List related leads

Retrieve a list of all related leads with a likeness score greater than or equal to 50 to a specified lead.

List related leads by threshold

Retrieve a list of all related leads greater than or equal to a specified likeness score/threshold.

Raw HTTP request (advanced)

Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication.