Events

Get lead event details by ID

Returns one event record by ID, including event type, timestamps, related entities, and summary payload data.

get/events/{eventId}

Request

  • Base URL: https://api.leadping.ai
  • URL: https://api.leadping.ai/events/{eventId}
  • Auth: HTTP bearer

Path parameters

eventIdstring required

The ID of the event.

Response

Event was successfully retrieved.

voicemailUrlstring uri nullable

Playable recording URL for voicemail events.

isDemoboolean
idstring

Unique Leadping identifier for this event timeline table row.

eventTypestring

Event type used to classify this timeline, SMS, call, or automation event.

eventCategorystring nullable

High-level category used to group this Leadping event.

timelineType'Message' | 'Sms' | 'Mms' | 'Call' | 'Voicemail' | 'Note' | 'LeadStatusChange' | 'LeadCreated' | 'LeadUpdated' | 'Notification' | 'Payment' | 'Warmup'

Classifies the kind of activity displayed in a lead or conversation event timeline.

timelineCategorystring

Timeline category used to group events for display and filtering.

descriptionstring

Human-readable description that explains this event timeline table row to API users.

conversationIdstring nullable

Conversation ID that links this event timeline table row to the Leadping inbox thread.

leadIdstring nullable

Lead ID associated with this timeline event.

relatedEntityTypestring nullable

Related entity type connected to this event or notification.

relatedEntityIdstring nullable

Related entity ID connected to this event or notification.

automationRunIdstring nullable

Automation run ID opened from this automation event.

summarystring nullable

Short human-readable summary of this event timeline table row for lists, timelines, and notifications.

directionstring nullable

Communication direction for this event timeline table row, such as inbound or outbound.

status'Pending' | 'InProgress' | 'Completed' | 'Cancelled' | 'Scheduled' | 'Queued' | 'Sending' | 'Sent' | 'Received' | 'Delivered' | 'Undeliverable' | 'Opted out' | 'Blocked' | 'Initiated' | 'Ringing' | 'Active' | 'Ended' | 'Missed' | 'Voicemail' | 'Failed' | 'Canceled' nullable

Provides the customer-facing outcome shown for an item in a lead or conversation timeline.

statusReasonstring nullable

Human-readable reason explaining the current status of this event timeline table row.

trafficType'RealLead' | 'Warmup' | 'Test' | 'SystemInternal' | 'FailedAttempt' nullable

Classifies messaging traffic by conversational, informational, marketing, or other compliance-relevant purpose.

fromPhoneNumberIdstring nullable

Sender phone number ID used for this outbound SMS or call.

outboundPhoneNumberIdstring nullable

Phone number ID selected for outbound delivery.

fromPhoneNumberstring nullable

Sender phone number used for this communication.

toPhoneNumberstring nullable

Recipient phone number used for this communication.

selectionReason'StickyConversation' | 'LeadAssigned' | 'CampaignOrSource' | 'Preferred' | 'LocalArea' | 'HealthyPool' | 'FallbackDefault' | 'ManualOverride' nullable

Explains why Leadping selected, rejected, or substituted an outgoing caller or messaging number.

wasManuallyOverriddenboolean

Indicates whether a user manually overrode Leadping's automatic number selection for this event timeline table row.

campaignIdstring nullable

Messaging campaign identifier associated with this event timeline table row.

sourceIdstring nullable

Lead source ID used for event attribution.

complianceActionstring nullable

Compliance action applied to this message, lead, or sender.

billingStatusstring nullable

Billing state for this communication, charge, or transaction.

billableAmountnumber double nullable

Monetary amount billed for this Leadping communication or transaction.

errorCodestring nullable

Machine-readable error code returned while processing this event timeline table row.

retryCountinteger

Number of retry attempts already made for this event timeline table row.

queuedAtstring date-time nullable

UTC timestamp when Leadping queued this event timeline table row for processing.

sendingStartedAtstring date-time nullable

UTC timestamp when Leadping began sending this message.

sentAtstring date-time nullable

UTC timestamp when Leadping sent this message to the provider.

deliveredAtstring date-time nullable

UTC timestamp when the provider confirmed delivery.

receivedAtstring date-time nullable

UTC timestamp when Leadping received this inbound event or message.

failedAtstring date-time nullable

UTC timestamp when processing failed for this event timeline table row.

undeliverableAtstring date-time nullable

UTC timestamp when the provider marked the message undeliverable.

blockedAtstring date-time nullable

UTC timestamp when Leadping blocked this communication.

nextRetryAtstring date-time nullable

UTC timestamp when Leadping will retry this event timeline table row.

scheduledForstring date-time nullable

UTC timestamp when the related delivery or workflow action is scheduled to run.

scheduledReasonstring nullable

Reason Leadping scheduled this delivery for a later time.

canceledAtstring date-time nullable

UTC timestamp when this delivery or workflow was canceled.

cancelReasonstring nullable

Reason this delivery, run, or request was canceled.

createdAtstring date-time

UTC timestamp when this event timeline table row was created.

createdBystring

Display name or identifier for the person or system that created this event timeline table row.

actorUserIdstring nullable

User ID for the person or system that created this event timeline table row.

actorDisplayNamestring nullable

Display name for the person or system that created this event timeline table row.

actorEmailstring email nullable

Email address for the person who created this event timeline table row.

Changes

No recorded changes to this operation across all 1 revision of this API.