Destinations

Destinations are similar to a recipient step in a flow; they represent an external system which receives lead data at the end of a flow. Data is sent to a Destination if all prior steps have completed successfully, and are skipped if an error occurs in a prior step.

Destinations are configured once and then globally available within all of an account's flows. Destinations must be configured within the LeadConduit app, and cannot be configured directly via the API. However, once a destination is configured, it can be queried via the API. Configured destinations can also be added to flows via the API.

Destination

An internal representation of a Prismatic instance.

name
string

A customizable name of the destination.

integration_name
string

The name of the integration as published in the Marketplace.

integration_icon_url
string

Pre-signed URL for the integration icon.

instance_id
string

The Prismatic instance ID.

Array of objects

A list of actions available in the configured instance. These map to Prismatic "flows" within an instance.

object

Contains data on flows in which the destination is used. This field is optional and is only included when the include=flow_usages query parameter is included in the request.

{
  • "name": "Salesforce",
  • "integration_name": "string",
  • "integration_icon_url": "string",
  • "instance_id": "string",
  • "actions": [
    • {
      • "name": "Add Lead",
      • "action_id": "Add Lead",
      • "webhook_url": "string"
      }
    ],
  • "flow_usages": {
    • "count": 0,
    • "flows": [
      • {
        • "id": "5fd4371e940df5a34a3888b2",
        • "name": "string"
        }
      ]
    }
}

List all destinations configured for the account

The /destinations resource is used to query destinations which have been configured in the LeadConduit app. If no destinations are configured for your account, this resource will return an empty array. Destinations returned from this endpoint can be added to flows.

SecurityAPIKey
Request
query Parameters
include
string

Additional properties to include in the response.

Value: "flow_usages"
Responses
200

OK

401

Authorization information is missing or invalid.

get/destinations
Request samples 
Response samples 
application/json
[
  • {
    • "name": "Salesforce",
    • "integration_name": "string",
    • "integration_icon_url": "string",
    • "instance_id": "string",
    • "actions": [
      • {
        • "name": "Add Lead",
        • "action_id": "Add Lead",
        • "webhook_url": "string"
        }
      ],
    • "flow_usages": {
      • "count": 0,
      • "flows": [
        • {
          • "id": "5fd4371e940df5a34a3888b2",
          • "name": "string"
          }
        ]
      }
    }
]