Skip to main content
GET
/
events
List all events
curl --request GET \
  --url https://app.leadconduit.com/events \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "id": "5fd4371e940df5a34a3888b2",
    "outcome": "success",
    "reason": "<string>",
    "type": "source",
    "vars": {},
    "host": "<string>",
    "start_timestamp": 123,
    "end_timestamp": 123,
    "firehose": {
      "credential_id": "5fd4371e940df5a34a3888b2",
      "enabled": true,
      "bucket": "<string>",
      "prefix": "<string>",
      "services": {
        "aws": {
          "enabled": true,
          "credential_id": "5fd4371e940df5a34a3888b2",
          "bucket": "<string>",
          "prefix": "<string>"
        },
        "azure": {
          "enabled": true,
          "credential_id": "5fd4371e940df5a34a3888b2",
          "bucket": "<string>",
          "prefix": "<string>"
        }
      }
    },
    "ms": 123,
    "wait_ms": 123,
    "overhead_ms": 123,
    "lag_ms": 123,
    "total_ms": 123,
    "handler_version": "<string>",
    "version": "<string>",
    "cap_reached": true,
    "flow_ping_limits": {
      "id": "5fd4371e940df5a34a3888b2",
      "name": "<string>",
      "maximum": 123,
      "duration": 123,
      "duration_units": "<string>",
      "time_zone": "America/New_York",
      "created_at": "2023-11-07T05:31:56Z"
    },
    "source_ping_limits": {
      "id": "5fd4371e940df5a34a3888b2",
      "name": "<string>",
      "maximum": 123,
      "duration": 123,
      "duration_units": "<string>",
      "time_zone": "America/New_York",
      "created_at": "2023-11-07T05:31:56Z"
    },
    "ping_limit_reached": true,
    "expires_at": "2023-11-07T05:31:56Z",
    "module_id": "<string>",
    "package_version": "<string>",
    "acceptance_criteria": {
      "rule_set": {
        "op": "and",
        "rules": [
          {
            "lhv": "lead.state",
            "op": "is equal to",
            "rhv": "TX",
            "id": "1aacd0",
            "rule_set": "<unknown>"
          }
        ],
        "id": "0d144a"
      },
      "outcome": "failure",
      "reason": "Lead must live in TX"
    },
    "step_count": 4,
    "appended": {},
    "request": {
      "method": "POST",
      "uri": "https://app.leadconduit.com/flows/5fd4371e940df5a34a3888b2/sources/6369a0e534c9d4ebe142e0ef/submit",
      "version": "1.1",
      "headers": {
        "Content-Type": "application/json",
        "Accept": "application/json"
      },
      "body": "{\"email\":\"johndoe@email.com\",\"phone_1\":\"5127891111\"}",
      "timestamp": 123
    },
    "response": {
      "version": "1.1",
      "headers": {
        "Content-Type": "application/json",
        "Accept": "application/json"
      },
      "body": "{\"outcome\":\"success\",\"lead\":{\"id\":\"63cc6f0e55254d7d1c4c3037\"}}",
      "timestamp": 123,
      "status": 201,
      "status_text": "Created"
    }
  }
]

Authorizations

​
Authorization
string
header
required

LeadConduit uses HTTP Basic Authentication with the username API and your API key as the password.

For example: API:1f1b96c9150d8050e858c043d543bb4eadae0e6f'

Query Parameters

​
after_id
string

Return only events that were created after the one with this ID (exclusive) 24 character alpha-numeric BSON identifier

Pattern: ^[0-9a-fA-F]{24}$
Example:

"5fd4371e940df5a34a3888b2"

​
before_id
string

Return only events that were created before the one with this ID (exclusive) 24 character alpha-numeric BSON identifier

Pattern: ^[0-9a-fA-F]{24}$
Example:

"5fd4371e940df5a34a3888b2"

​
start
string<date-time>

Return only events that were created at or after this time

​
end
string<date-time>

Return only events that were created at or before this time

​
rules
string

Stringified array of Rules to select matching events

​
include
string[]

An array of fields to include. Cannot be used with exclude.

​
exclude
string[]

An array of fields to exclude. Cannot be used with include.

​
limit
integer

The maximum number of events to return (maximum limit is 1000, default 100)

Required range: 1 <= x <= 1000
​
sort
string

The results are sorted by date. Use asc to sort by oldest first or desc to sort by newest first. Defaults to desc.

Response

OK

An event tracks what happened with a lead at a particular step in a flow. An event is a self-contained snapshot of the state of the lead at the time the lead visited the step. It contains a full copy of all lead data, along with all data that was appended before that step. Every event contains the below properties.

​
id
string
required

24 character alpha-numeric BSON identifier

Pattern: ^[0-9a-fA-F]{24}$
Example:

"5fd4371e940df5a34a3888b2"

​
outcome
enum<string>
required

The outcome of the event

Available options:
success,
failure,
error
​
reason
string
required

The reason for a failure or error outcome

​
type
enum<string>
required

Recorded after a source submits a lead to a flow

Available options:
source
​
vars
Source Variables · object

All data available at the time LeadConduit started processing this event

​
host
string
​
start_timestamp
integer

The number of milliseconds elapsed since epoch at the start of the step processing

​
end_timestamp
integer

The number of milliseconds elapsed since epoch at the end of the step processing

​
firehose
object
​
ms
integer

The number of milliseconds that elapsed while processing the lead

​
wait_ms
integer

The number of milliseconds that LeadConduit spent waiting for all recipients to respond

​
overhead_ms
integer

The number of milliseconds of overhead that LeadConduit added while processing the step

​
lag_ms
integer
​
total_ms
integer

The number of milliseconds that elapsed since the lead was submitted

​
handler_version
string

The version of the lead handler

​
version
string

The schema version of the event

​
cap_reached
boolean
​
flow_ping_limits
Ping Limit · object

The ping limit configuration is defined in a flow on a source, or directly on the flow itself. The configuration controls the behavior of the ping limit by setting the maximum and the duration. The counter for a ping limit is kept as a standalone record which shares ping limit's ID.

​
source_ping_limits
Ping Limit · object

The ping limit configuration is defined in a flow on a source, or directly on the flow itself. The configuration controls the behavior of the ping limit by setting the maximum and the duration. The counter for a ping limit is kept as a standalone record which shares ping limit's ID.

​
ping_limit_reached
boolean
​
expires_at
string<date-time>

The time this event will be automatically deleted from LeadConduit (events are retained for 90 days)

​
module_id
string

The integration module ID configured for the source

​
package_version
string

The semantic version of the integration package

​
acceptance_criteria
Acceptance Criteria · object

The acceptance criteria configured on the source when the lead was processed

​
step_count
integer

The number of steps processed for this lead (>= 0 and <= total number of steps)

Example:

4

​
appended
object

All data appended while handing the lead

​
request
object

The inbound HTTP request

​
response
object

The inbound HTTP response