Skip to main content
GET
Get event

Authorizations

Authorization
string
header
required

Bearer access token issued by Peerlogic.

Path Parameters

id
string
required

A unique value identifying this event.

Response

Successful response for get event.

call
object
read-only

Call context associated with the event.

first_follow_up_call
string
read-only

First follow-up call associated with the opportunity, when available.

created_at
string<date-time>
read-only

Time when Peerlogic created the event record.

followed_up_at
string
read-only

Time when the related opportunity was followed up, when available.

id
string
read-only

Unique identifier for this resource.

Minimum string length: 1
is_followed_up
string
read-only

Whether follow-up activity is associated with the event's opportunity.

is_open
string
read-only

Whether the related opportunity remains open.

is_significant
boolean
read-only

Whether Peerlogic classified the event as significant for follow-up or reporting.

modified_at
string<date-time>
read-only

Time when the event record was last updated.

significant_event_id
string
read-only

Identifier of the significant event associated with this record, when applicable.

opportunity
string
read-only

Opportunity context associated with the event, when one was identified.

trigger_type
enum<string>
read-only

Activity classification that produced the event.

Available options:
missed_call,
missed_call_existing_patient,
missed_call_cancellation_reschedule,
missed_call_current_appointment,
missed_call_non_business,
missed_call_business,
high_value_missed_call,
connected_call,
connected_call_existing_patient,
connected_call_new_patient,
connected_call_high_value,
lost_opportunity,
lost_opportunity_new_patient,
lost_opportunity_existing_patient,
lost_opportunity_high_value,
aimee_escalation,
aimee_booked,
aimee_reschedule,
aimee_cancellation,
aimee_inbound_message,
extracted_opportunity,
care_task_handed_off,
voip_integration_disconnect,
ehr_integration_disconnect,
fax_inbound_received,
fax_outbound_failed