kustomer-client
    Preparing search index...

    Function getaCustomerEvent

    • Get customer event Retrieves a single customer event based on the unique IDs of the customer and the event.

      Any one of the following roles is required for this endpoint:

      Legacy Role Equivalent Permission Set Role
      org.user.event.read org.permission.event.read

      Type Parameters

      • ThrowOnError extends boolean = true

      Parameters

      Returns RequestResult<
          {
              data: {
                  attributes: {
                      changes: {
                          attributes: {
                              conversationCounts: {
                                  after: {
                                      all: number;
                                      done: number;
                                      open: number;
                                      snoozed: number;
                                  };
                                  before: { all: number; done: number; open: number; snoozed: number };
                                  op: string;
                              };
                              progressiveStatus: {
                                  after: string;
                                  before: null
                                  | string;
                                  op: string;
                              };
                              rev: { after: number; before: number; op: string };
                          };
                          relationships: { [key: string]: unknown };
                      };
                      createdAt: string;
                      location: null
                      | string;
                      meta: null | string;
                      modifiedAt: null | string;
                      name: string;
                      publishedAt: string;
                      type: string;
                      updatedAt: string;
                  };
                  id: string;
                  links: { self: string };
                  relationships: {
                      createdBy: null | string;
                      customer: {
                          data: { id: string; type: string };
                          links: { self: string };
                      };
                      modifiedBy: null
                      | string;
                      org: { data: { id: string; type: string }; links: { self: string } };
                  };
                  type: string;
              };
          },
          unknown,
          ThrowOnError,
      >

    Settings

    Member Visibility