Sign in

v1

latestOpenAPI 3.1.02026-08-0612447737.4 KB
Event

List Events

Retrieve a list of events

get/event

Query parameters

idstring

Event ID

created_atstring

Event creation date

updated_atstring

Latest update

conversation_idstring

Conversation ID

organisation_idstring

Organisation ID

typestring

Type of event

source_typestring

Source type

target_typestring

Target type

metadatastring

Metadata of event

source_rule_idstring

Source rule ID

source_employee_idstring

Source employee ID

source_api_token_idstring

Source API token ID

source_comment_idstring

Source comment ID

source_channel_idstring

Source channel ID

source_recipient_idstring

Source recipient ID

target_employee_idstring

Target employee ID

target_comment_idstring

Target comment ID

target_message_idstring

Target message ID

target_tag_idstring

Target tag ID

target_message_action_idstring

Target message action ID

target_inbox_idstring

Target inbox ID

selectstring

Filtering Columns

orderstring

Ordering. Allowed Fields: created_at

offsetstring

Limiting and Pagination

limitstring

Limiting and Pagination

Headers

Rangestring

Limiting and Pagination

Range-Unitstring

Limiting and Pagination

Response

OK

idstring uuid

Event ID

created_atstring timestamp with time zone

Event creation date

updated_atstring timestamp with time zone

Latest update

conversation_idstring uuid

Conversation ID

organisation_idstring uuid

Organisation ID

type'assign' | 'unassign' | 'close' | 'reopen' | 'comment' | 'mention' | 'inbound' | 'outbound' | 'tag' | 'untag' | 'sending_error' | 'message_bounce_error' | 'submit' | 'subject_change' | 'submission_error' | 'read' | 'archive' | 'action_click' | 'inbox_change' | 'spam' | 'ham' | 'contact_deletion' | 'external_id_change' | 'message_reaction' | 'form_submission_start' | 'inbound_voice_call' public.event_type

Type of event

source_type'employee' | 'channel' | 'comment' | 'message' | 'tag' | 'recipient' | 'message_action' | 'api_token' | 'service_role' | 'inbox' | 'rule' | 'form_submission' | 'cs_agent_session' | 'cs_agent' | 'voice_call' public.event_entity_type nullable

Source type

target_type'employee' | 'channel' | 'comment' | 'message' | 'tag' | 'recipient' | 'message_action' | 'api_token' | 'service_role' | 'inbox' | 'rule' | 'form_submission' | 'cs_agent_session' | 'cs_agent' | 'voice_call' public.event_entity_type nullable

Target type

metadataobject nullable

Metadata of event

source_rule_idstring uuid nullable

Source rule ID

source_employee_idstring uuid nullable

Source employee ID

source_api_token_idstring uuid nullable

Source API token ID

source_comment_idstring uuid nullable

Source comment ID

source_channel_idstring uuid nullable

Source channel ID

source_recipient_idstring uuid nullable

Source recipient ID

target_employee_idstring uuid nullable

Target employee ID

target_comment_idstring uuid nullable

Target comment ID

target_message_idstring uuid nullable

Target message ID

target_tag_idstring uuid nullable

Target tag ID

target_message_action_idstring uuid nullable

Target message action ID

target_inbox_idstring uuid nullable

Target inbox ID