API Reference

The Event object

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

integer

ID of the event.

uuid

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

ISO 8601 datetime

When the event was created.

object

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

integer

The ID of the Gorgias object associated with the event.

string

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

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, 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-reactivated, integration-data-item-created, integration-data-item-deleted, instagram-direct-message-created, macro-created, macro-deleted, macro-updated, macro-applied, macro-params-updated, 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, ticket-assigned, ticket-chat-updated, ticket-closed, ticket-created, ticket-customer-updated, ticket-deleted, ticket-marked-spam, ticket-merged, ticket-read-status-updated, ticket-reopened, ticket-snoozed, ticket-self-unsnoozed, 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-excluded-from-csat, ticket-excluded-from-auto-merge, 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-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, 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.

integer

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

string

URI of the event.

Event example object

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