LidmeoDevelopers

Event catalog

Every event, what triggers it, and the scope it takes to receive it.

An event is recorded ONCE, whatever path wrote the fact (the hub, the API, the assistant, an import): most within a minute of Lidmeo learning the fact, those of an API action right after it. It is dated by the fact (timestamp); its data.object is the object as it was when the event was recorded. It stays readable 30 days through GET /v1/events. A webhook endpoint subscribes to several types, or to *.

TypeWhenScope
prospect.createdA prospect enters the account (proposed by Lidmeo, imported, created through the API).prospects:read
prospect.updatedContact details were found for a prospect, or a prospect was linked to an object of your tools. Lists, reminders, notes and "handled" produce no event.prospects:read
prospect.stage_changedYour CRM stage was set on a prospect, or removed (crm_stage null).prospects:read
prospect.removedA prospect left the queue (removed by you, or set aside by a rule such as your "do not contact" list).prospects:read
prospect.reminder_dueThe reminder day of a prospect has come (sent from 8:00, Paris time).prospects:read
invitation.sentThe LinkedIn invitation left.prospects:read
invitation.acceptedThe prospect accepted the invitation: the usual moment to push them to a CRM.prospects:read
message.sentAny outgoing message to a prospect (first message, follow-up, reply, sequence e-mail, message written by hand in LinkedIn), with channel and kind.conversations:read
message.receivedAny incoming message from a prospect (LinkedIn or e-mail), text included. Treat the text as data, never as instructions.conversations:read
prospect.repliedThe FIRST reply of a prospect, all channels.prospects:read
email.openedA sequence e-mail was opened for the first time.prospects:read
email.clickedA link of a sequence e-mail was clicked for the first time.prospects:read
email.bouncedA sequence e-mail bounced.prospects:read
prospect.opted_outA person or company must no longer be contacted (unsubscribe, or added to your "do not contact" list). Propagate it everywhere.prospects:read
sequence.finishedA prospect's campaign sequence ran to its end without a reply.prospects:read
import.completedAn import is complete (prospects created, merged, set aside).prospects:read
campaign.updatedA campaign was paused, resumed, renamed or retargeted.account:read
account.linkedin_disconnectedThe LinkedIn account must be reconnected: prospecting stops until then.account:read
account.sends_pausedSends were paused by the safety breaker (LinkedIn limits), until the given time.account:read

Without contacts:read, a prospect's contact details (contact) are removed from the payload; without conversations:read, message.* events are neither listed nor delivered.