Events are our way of letting you know when something interesting happens in your account. For example, when a ticket is created we create a ticket-created event; When a user is updated we create a user-updated event.

Event properties

id

integer

ID of the event.

context

uuid

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

created_datetime

ISO 8601 datetime

When the event was created.

data

object

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

object_id

integer

The ID of the Gorgias object associated with the event.

object_type

string

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

type

string

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, instagram-direct-message-created, 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-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-action-failed, 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-customer-values-updated, 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-location-updated, user-status-changed, user-typing-status-updated, 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_id

integer

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

uri

string

URI of the event.

Event example object

{
  "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
}