Sign in

v1

latestOpenAPI 3.1.02026-07-24111290748.0 KB
Events

List events

List events, paginated, and ordered by their creation date, with the most recently created first.

get/api/events

Query parameters

ltstring date-time

Less than the given value.

ltestring date-time

Less than or equal to the given value.

gtstring date-time

Greater than then given value.

gtestring date-time

Greater than or equal to the given value.

Comparators used to filter events on their creation date.

cursorstring
Example:cHJldl9fNl9fMjAyMS0wMy0wMyAwNjowMDowMA==

Value indicating your position in the list of all events. If omitted, the first events of the list will be returned.

limitinteger

Maximum number of events to return.

object_idinteger

ID of the object associated with the events to return.

object_type'Account' | 'AccountSetting' | 'Macro' | 'Tag' | 'Customer' | 'Team' | 'View' | 'Widget' | 'CustomField' | 'CustomFieldCondition' | 'User' | 'TicketMessage' | 'Ticket' | 'Rule' | 'Integration' | 'SatisfactionSurvey'

Type of the object associated with the events to return.

order_by'created_datetime' | 'created_datetime:asc' | 'created_datetime:desc'

Attribute used to order events.<br>Value of <span style={{color: 'red'}}>created_datetime has been deprecated</span>, use created_datetime:asc or created_datetime:desc instead.

typesstring[]

Types of the events to return.

user_idsinteger[]

IDs of the users who triggered the events to return.

Response

A list of events.

idinteger

ID of the event.

contextstring uuid nullable

An uuid4 used to group a sequence of related events together, meaning that an event triggered another event and so on.

created_datetimestring date-time

When the event was created.

dataobject

Data associated with the event (key-value data).

object_idinteger

The ID of the Gorgias object associated with the event.

object_type'Account' | 'AccountSetting' | 'Customer' | 'CustomField' | 'CustomFieldCondition' | 'CustomUserAvailabilityStatus' | 'CustomerExternalData' | 'Integration' | 'Macro' | 'Order' | 'Role' | 'Rule' | 'SatisfactionSurvey' | 'Shopper' | 'ShopperAddress' | 'Subscription' | 'Tag' | 'Team' | 'TicketMessage' | 'Ticket' | 'User' | 'UserSetting' | 'View' | 'Widget'

The type of the existing Gorgias object associated with the event.

typestring

Type of the event. Event types are used to discriminate between events. List of event types: account-created, account-deactivated, account-setting-created, account-setting-updated, account-updated, account-renamed, action-executed, facebook-comment-created, facebook-comment-deleted, facebook-comment-edited, facebook-comment-hidden, facebook-comment-unhidden, facebook-comment-liked, facebook-comment-unliked, facebook-message-created, facebook-message-deleted, facebook-message-edited, facebook-post-created, facebook-post-deleted, facebook-post-edited, facebook-review-deleted, integration-created, integration-deleted, integration-updated, integration-deactivated, integration-reactivation-started, integration-reactivated, integration-data-item-created, integration-data-item-deleted, macro-created, macro-deleted, macro-updated, macro-applied, macro-params-updated, macro-archived, macro-unarchived, rule-created, rule-priority-updated, rule-deleted, rule-executed, rule-updated, rule-deactivated, rule-reactivated, rules-pipeline-executed, subscription-created, subscription-updated, subscription-self-serve-changed, tag-created, tag-deleted, tag-merged, tag-updated, tag-renamed, team-created, team-deleted, team-updated, team-member-created, team-member-deleted, ticket-assigned, ticket-chat-updated, ticket-closed, ticket-created, ticket-customer-updated, ticket-deleted, ticket-excluded-from-auto-merge, ticket-excluded-from-csat, ticket-marked-spam, ticket-merged, ticket-read-status-updated, ticket-reopened, ticket-satisfaction-survey-skipped, ticket-self-unsnoozed, ticket-sla-policy-assigned, ticket-snoozed, ticket-split, ticket-subject-updated, ticket-tags-added, ticket-tags-removed, ticket-team-assigned, ticket-team-unassigned, ticket-trashed, ticket-typing-activity-shopper-started, ticket-unassigned, ticket-unmarked-spam, ticket-untrashed, ticket-updated, ticket-viewed, ticket-handed-over, ticket-message-chat-created, ticket-message-created, ticket-message-deleted, ticket-message-failed, ticket-message-summary-created, ticket-message-updated, customer-created, customer-updated, customer-merged, customer-deleted, customer-external-data-updated, custom-field-created, custom-field-updated, custom-field-condition-created, custom-field-condition-updated, custom-field-condition-enabled, custom-field-condition-disabled, custom-field-condition-deleted, custom-fields-ticket-values-updated, self-service-configurations-updated, self-service-configurations-update-started, user-created, user-invited, user-updated, user-mentioned, user-deleted, user-logged-in, user-logged-out, user-impersonated, user-password-changed, user-password-reset, user-2fa-changed, user-status-changed, user-setting-created, user-setting-updated, custom-availability-status-created, custom-availability-status-updated, custom-availability-status-deleted, views-count-updated, view-deactivated, view-created, view-deleted, view-updated, view-section-created, view-section-updated, view-section-deleted, widget-created, widget-deleted, widget-updated, satisfaction-survey-sent, satisfaction-survey-updated, satisfaction-survey-responded.

user_idinteger

ID of the user who triggered the event. If empty, the event has been triggered automatically (E.g: by a rule).

uristring

URI of the event.

Example response

[
  {
    "id": 1234,
    "context": "dd4ff312-69df-494a-be96-1a58b3d8b8e0",
    "created_datetime": "2019-11-16T15:59:41.966927",
    "object_id": 123,
    "object_type": "Ticket",
    "type": "ticket-closed",
    "user_id": 123
  }
]