List events
const url = 'https://optlo.com/api/v1/events?limit=50&type=user.email_captured&order=desc';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://optlo.com/api/v1/events?limit=50&type=user.email_captured&order=desc' \ --header 'Authorization: Bearer <token>'Returns immutable snapshots ordered by workspace ingestion sequence. Only events permitted by the key’s read scopes are visible. Explicitly requesting an unauthorized type returns 403. Events are retained for 30 days after ingestion. An expired cursor returns 410 and requires resource resynchronization. In ascending order, always retain nextCursor, including on empty pages; caught-up cursors renew their validity for another 30 days.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Maximum number of resources to return on one page.
Opaque cursor bound to workspace, order, type selection and effective event visibility; survives key rotation. Keep the latest nextCursor when polling in ascending order, including on empty pages.
Return only this event type. Omit to include all types permitted by the key’s read scopes.
Order by workspace ingestion sequence. Use asc to poll for new events.
Response
Section titled “Response”Success
Show child attributes
Resources on this page.
One of:
user.email_captured
Show child attributes
Unique identifier for the event. Use it to deduplicate webhook deliveries.
Version of the event envelope format.
Time the event occurred.
ID of the workspace where the event occurred.
Channel that caused the event.
Participant or API key that caused the event. For assistant activity in response to a message, the participant who sent that message. Null for activity without an attributed actor.
Show child attributes
Type of participant or API key that caused the event.
Unique identifier for the actor.
Identifier linking the event to its originating operation, when available.
A user’s email address was captured.
Snapshot of the user at the time of the event.
Show child attributes
User whose email address was captured.
Show child attributes
Unique identifier for the user.
Email address captured for the user.
conversation.created
Show child attributes
Unique identifier for the event. Use it to deduplicate webhook deliveries.
Version of the event envelope format.
Time the event occurred.
ID of the workspace where the event occurred.
Channel that caused the event.
Participant or API key that caused the event. For assistant activity in response to a message, the participant who sent that message. Null for activity without an attributed actor.
Show child attributes
Type of participant or API key that caused the event.
Unique identifier for the actor.
Identifier linking the event to its originating operation, when available.
A conversation was created.
Snapshot of the conversation at the time of the event.
Show child attributes
Newly created conversation.
Show child attributes
Unique identifier for the conversation.
ID of the user the conversation belongs to.
Time the conversation was created.
conversation.closed or conversation.reopened
Show child attributes
Unique identifier for the event. Use it to deduplicate webhook deliveries.
Version of the event envelope format.
Time the event occurred.
ID of the workspace where the event occurred.
Channel that caused the event.
Participant or API key that caused the event. For assistant activity in response to a message, the participant who sent that message. Null for activity without an attributed actor.
Show child attributes
Type of participant or API key that caused the event.
Unique identifier for the actor.
Identifier linking the event to its originating operation, when available.
A conversation was closed or reopened.
Snapshot of the conversation’s new state.
Show child attributes
Conversation whose open or closed state changed.
Show child attributes
Unique identifier for the conversation.
ID of the user the conversation belongs to.
Time the conversation was closed. Null for a reopened conversation.
conversation.escalated
Show child attributes
Unique identifier for the event. Use it to deduplicate webhook deliveries.
Version of the event envelope format.
Time the event occurred.
ID of the workspace where the event occurred.
Channel that caused the event.
Participant or API key that caused the event. For assistant activity in response to a message, the participant who sent that message. Null for activity without an attributed actor.
Show child attributes
Type of participant or API key that caused the event.
Unique identifier for the actor.
Identifier linking the event to its originating operation, when available.
A conversation was escalated to an operator.
Snapshot of the conversation and its escalation.
Show child attributes
Conversation that was escalated.
Show child attributes
Unique identifier for the conversation.
ID of the user the conversation belongs to.
Details of the escalation.
Show child attributes
Unique identifier for the escalation.
ID of the assistant that escalated the conversation.
Position of the escalation in the conversation’s event sequence.
message.created or note.created
Show child attributes
Unique identifier for the event. Use it to deduplicate webhook deliveries.
Version of the event envelope format.
Time the event occurred.
ID of the workspace where the event occurred.
Channel that caused the event.
Participant or API key that caused the event. For assistant activity in response to a message, the participant who sent that message. Null for activity without an attributed actor.
Show child attributes
Type of participant or API key that caused the event.
Unique identifier for the actor.
Identifier linking the event to its originating operation, when available.
A customer-visible message or internal note was created.
Snapshot of the message at the time of the event.
Show child attributes
Newly created message or internal note.
Show child attributes
Unique identifier for the message or note.
ID of the conversation containing this message.
Whether this is a customer-visible message or an internal note.
Markdown text of the message or note. Literal characters typed by users are backslash-escaped.
Participant who sent the message.
Show child attributes
Unique identifier for the sender.
Type of participant who sent the message.
Time the message was created.
Position of the message in the conversation’s event sequence.
ID of the message being replied to, if any.
Pass this cursor to retrieve the next page. Null when no further page is available. When polling events in ascending order, retain the cursor even on empty pages.
Example
{ "data": [ { "id": "evnt_n5p8r2k6m4x9q3v7b1c0dfgh", "version": 1, "type": "message.created", "createdAt": "2026-10-13T09:10:00.000Z", "workspaceId": "ws_B8kN4pR6xZ2", "origin": "api", "actor": { "role": "apiKey", "id": "key_pL6rT3mN9xB2vQ8k_B8kN4pR6xZ2" }, "causationId": "op_r4k7m2p9x6n8q3v5b1c0dfgh", "data": { "message": { "id": "msg_h7m4k2r9p6x8n3q5v1z0bcdf", "conversationId": "conv_B8kN4pR6xZ2_kR7mP3xB9nQ2vL5z", "kind": "message", "content": "Hi Sam, your workspace is ready. Can I help you get started?", "sender": { "id": "acc_tQ8nL4zR6mB2xP7k", "role": "operator" }, "createdAt": "2026-10-13T09:10:00.000Z", "sequence": 1, "replyToMessageId": null } } } ], "nextCursor": null}