Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Started added descriptions of the new arguments passed to the event handlers

...

  • client_group_id - The ID of the client group that was created.
  • vars - An array of input data which may include:
  • name - The name of this group
  • description - A description of this group
  • company_id - The company ID this group belongs to
  • color - The HTML color that represents this groupClientGroupsedit client group updatedEventsClientGroupsCallbackeditclientgroup client group updatedvars - An array of input data which may include:
  • name - The name of this group
  • description - A description of this group
  • company company this group belongs to
  • color - The HTML color that represents this group
  • client_group_id - The ID of the client group that was removed. addedEventsClientsCallback addedid_code client's reference ID code
  • user_id - The client's user ID
  • client_group_id - The client group this user belongs to
  • status - The status of this client
  •  ClientsaddNote note createdEventsClientsCallbackaddNotenote note createdtitle title the note The the note
  • stickied - Whether this note is sticked or not
  • client_ updated.vars - An array of input data which may include:
  • id_code - The client's reference ID code
  • user_id - The client's user ID
  • client_group_id - The client group this user belongs to
  • status - The status of this clientdeleteNote note removeddeleteNotenote_id - The ID of the note that was removed4
    EventTriggered WhenDefault Event HandlerParametersReturnsSince
    Appcontroller.preActionA URI is requestedEventsAppControllerCallback::preAction()voidvoid3.0
    Appcontroller.structureA URI is requested without AJAXEventsAppControllerCallback::structure()
    • controller - The controller being requested
    • action - The action being requested
    • portal - The portal in use ('admin' or 'client')

    array

    Key/value pairs to be set as variables in the structure view. Special keys include:

    • head - An array of markup to set in the <head> tag
    • body_start - An array of markup to set just after the <body> tag
    • body_end - An array of markup to set just before the </body> tag
    3.3
    CalendarEvents.addA calendar event is createdEventsCalendarEventsCallback::add()
    • calendar_event_id - The ID of the calendar event that was created.
    • vars - An array of input data which may include:
      • company_id - The ID of the company under which this event was added
      • staff_id - The ID of the staff member that created this event
      • shared - Whether or not this event is shared among other staff members of this company
      • title - The title of the event
      • url - The URL this event is linked to
      • start_date - The start date of the event
      • end_date - The end date of the event
      • all_day - Whether or not this event spans the entire day of the start/end dates

     

    void4.1
    CalendarEvents.editA calendar event is updatedEventsCalendarEventsCallback::edit()
    • calendar_event_id - The ID of the calendar event that was updated.
    • vars - An array of input data which may include:
      • company_id - The ID of the company under which this event was added
      • staff_id - The ID of the staff member that created this event
      • shared - Whether or not this event is shared among other staff members of this company
      • title - The title of the event
      • url - The URL this event is linked to
      • start_date - The start date of the event
      • end_date - The end date of the event
      • all_day - Whether or not this event spans the entire day of the start/end dates
    void
    • old_calendar_event(4.
    1
    CalendarEvents.deleteA calendar event is removedEventsCalendarEventsCallback::delete()
    • 3.0)- An object representing the previous state of the calendar object
      • company_id - The ID of the company under which this event was added
      • staff
      calendar_event
      • _id - The ID of the
      calendar event that was removed.
    void4.1

    ClientGroups.add

    A client group is created

    EventsClientGroupsCallback::add()

      • staff member that created this event
      • shared - Whether or not this event is shared among other staff members of this company
      • title - The title of the event
      • url - The URL this event is linked to
      • start_date - The start date of the event
      • end_date - The end date of the event
      • all_day - Whether or not this event spans the entire day of the start/end dates
      • staff_first_name - The first name of the staff user that create the calendar event
      • staff_last_name - The last name of the staff user that create the calendar event
    void4.1
    CalendarEvents.deleteA calendar event is removedEventsCalendarEventsCallback::delete()
    • calendar_
    • event_id - The ID of the
    • calendar event that was
    • removed.
    • old_calendar_event(4.3.0)- An object representing the previous state of the calendar object
      • company_id - The ID of the company under which this event was added
      • staff
      • _id - The
      • ID
    void4.1
      • of the staff member that created this event
      • shared - Whether or not this event is shared among other staff members of this company
      • title - The title of the event
      • url - The URL this event is linked to
      • start_date - The start date of the event
      • end_date - The end date of the event
      • all_day - Whether or not this event spans the entire day of the start/end dates
      • staff_first_name - The first name of the staff user that create the calendar event
      • staff_last_name - The last name of the staff user that create the calendar event
    ClientGroups.deleteA client group is removedEventsClientGroupsCallback::delete()
    void4.1Clients

    ClientGroups.add

    A client group is created

    EventsClientGroupsCallback::add()

    • client_group_id - The ID of the client group that was
    • created.
    • vars - An array of input data which may include:
        • name - The
        • name of this group
        • description - A description of this group
        • company_id - The company ID this group belongs to
        • color - The HTML color that represents this group
      void4.1
      ClientGroups.editA client group is updatedEventsClientGroupsCallback::edit()
      • client_group_id - The ID of the
      • client group that was
      • updated.
      • vars - An array of input data which may include:
          • name - The
          • name of
          • this group
          • description -
          • A description of
        void4.1
        Clients.createA client is createdEventsClientsCallback::create()
        • client - An object representing the client that was created.
        void3.1
          • this group
          • company_id - The company ID this group belongs to
          • color - The HTML color that represents this group
        • old_client_group(4.3.0)- An object representing the previous state of the group
          • id - The ID of this group
          • name - The name of this group
          • description - A description of this group
          • company_id - The company ID this group belongs to
          • color- The HTML color that represents this group
        void4.1
        ClientGroups.deleteA client group is removedEventsClientGroupsCallback::delete()
        • client_group_
        Clients.editA client is updatedEventsClientsCallback::edit()
        • id - The ID of the client group that was
        • removed.
        • old_client_group(4.3.0)- An object representing the previous state of the group
          • id - The ID of this group
          • name - The name of this group
          • description - A description of this group
          • company_id - The company ID this group belongs to
          • color- The HTML color that represents this group
        void4.1
        Clients.editNoteaddA note client is updatedaddedEventsClientsCallback::editNoteadd()
        • noteclient_id - The ID of the note client that was updatedadded.
        • vars - An array of input data which may include:
          • id_code - The client's reference ID code
          • user_id - The client's user ID
          • client_group_id - The client group this user belongs to
          • status - The status of this client
          • title - The title of the note
          • description - The description of the note
        void4.1
        Clients.deleteaddNoteA client note is removedcreatedEventsClientsCallback::deleteaddNote()
        • clientnote_id - The ID of the client note that was removed.
        void
        • created.
        • vars - An array of input data which may include:
          • title - The title of the note
          • description - The description of the note
          • stickied - Whether this note is sticked or not
        void4.1
        Clients.createA client is createdEventsClientsCallback::create()
        • client - An object representing the client that was created.
        void3.1
        CompaniesClients.addeditA company client is createdupdatedEventsCompaniesCallbackEventsClientsCallback::addedit()

         

        • company_client_id - The ID of the company client that was createdupdated.
        • vars - An array of input data which may include:
          • name id_code - The name of the company
          • hostname - The hostname of the company
          • address - The address of the company
          • phone - The phone number of the company
          • fax - The fax number of the company

         

        void4.1

        Companies.edit

        A company is updated

        EventsCompaniesCallback::edit()

        • company_id - The ID of the company that was updated.
        • vars - An array of input data which may include:
          • name - The name of the company
          • hostname - The hostname of the company
          • address - The address of the company
          • phone - The phone number of the company
          • fax - The fax number of the company
        void4.1
          • client's reference ID code
          • user_id - The client's user ID
          • client_group_id - The client group this user belongs to
          • status - The status of this client
        • old_client(4.3.0)- An object representing the previous state of the client
          • id - Internal ID of the group
          • id_format - The format with which to display the ID
          • id_value - The ID of the client to use for display
          • id_code - The client's reference ID code
          • user_id - The client's user ID
          • client_group_id - The client group this user belongs to
          • status - The status of this client
          • primary_account_id - The ID of the primary payment account for this client
          • primary_account_type - The type pf the primary payment account for this client
          • settings - A list of client settings

        Companies.delete

        A company is removed

        EventsCompaniesCallback::delete()

        • company_id - The ID of the company that was removed.
        void4.1
        ContactsClients.addeditNoteA contact note is addedupdatedEventsContactsCallbackEventsClientsCallback::addeditNote()

         

        • contactnote_id - The ID of the contact note that was createdupdated.
        • vars - An array of input data which may include:
          • client_id - The client ID this contact will be associated with
          • user_id - The user ID this contact belongs to if this contact has their own unique user record
          • contact_type - The type of contact
          • contact_type_id - The ID of the contact type if contact_type is 'other'
          • first_name - The first name of this contact
          • last_name - The last name of this contact
          • title - The business title for this contact
          • company - The company/organization this contact belongs to
          • email - This contact's email address
          • address1 - This contact's address
          • address2 - This contact's address line two
          • city - This contact's city
          • state - The 3-character ISO 3166-2 subdivision code, requires country
          • zip - The zip/postal code for this contact
          • country - The 2-character ISO 3166-1 country code, required if state is given
          • numbers An array of phone number data

         

        void4.1

        Contacts.edit

        A contact is updated

        EventsContactsCallback::edit()

          • title - The title of the note
          • description - The description of the note
        • old_client_note(4.3.0)- An object representing the previous state of the client note
          • id - The ID of client note
          • client_id - The ID the client to which this note is assign
          • staff_id - The ID of the staff member that created this note
          • title - The title of the note
          • description - The full description of this note
          • stickied - Whether to display this not on the client note
          • date_added - The timestamp in UTC that the note was added
          • date_updated - The timestamp in UTC that the note was last updated
        void4.1
        Clients.deleteA client is removedEventsClientsCallback::delete()
        • clientcontact_id - The ID of the contact client that was updatedremoved.
        • vars - An array of input data which may include:
          • user_id - The user ID this contact belongs to if this contact has their own unique user record
          • contact_type - The type of contact
          • contact_type_id - The ID of the contact type if contact_type is 'other'
          • first_name - The first name of this contact
          • last_name - The last name of this contact
          • title - The business title for this contact
          • company - The company/organization this contact belongs to
          • email - This contact's email address
          • address1 - This contact's address
          • address2 - This contact's address line two
          • city - This contact's city
          • state - The 3-character ISO 3166-2 subdivision code, requires country
          • zip - The zip/postal code for this contact
          • country - The 2-character ISO 3166-1 country code, required if state is given
          • numbers An array of phone number data
        void4.1
        • old_client(4.3.0) - An object representing the previous state of the client
          • id - Internal ID of the group
          • id_format - The format with which to display the ID
          • id_value - The ID of the client to use for display
          • id_code - The client's reference ID code
          • user_id - The client's user ID
          • client_group_id - The client group this user belongs to
          • status - The status of this client
          • primary_account_id - The ID of the primary payment account for this client
          • primary_account_type - The type pf the primary payment account for this client
          • settings - A list of client settings
        void4.1
        Clients.deleteNoteA note is removedEventsClientsCallback::deleteNote()
        • note

        Contacts.delete

        A contact is removed

        EventsContactsCallback::delete()

        • contact_id - The ID of the contact note that was removed.
        void4.1Emails.sendAn email template is sentEventsEmailsCallback::send()
        • old_client_note - An object representing the previous state of the client note
          • id - The ID of client note
        • action - The action that specifies the email group being sent
        • options - An array of options passed to Emails::send(), which may include:
          • to_client_id - The ID of the client the message was sent toto which this note is assign
          • from_staff_id - The ID of the staff member the message was sent from
          • from - The from address override
          • from_name - The from name override
          • reply_to - The reply to address override
        • tags - A key/value pair of replacement tags for the email.

        array

        Key/value pairs to merge with tags.

        3.1
        Emails.sendCustomA non-template based email is sentEventsEmailsCallback::sendCustom()
        • options - An array of options passed to Emails::send(), which may include:
          • to_client_id - The ID of the client the message was sent to
          • from_staff_id - The ID of the staff member the message was sent from
          • reply_to - The reply to address override
        • tags - A key/value pair of replacement tags for the email.

        array

        Key/value pairs to merge with tags.

        3.1
          • that created this note
          • title - The title of the note
          • description - The full description of this note
          • stickied - Whether to display this not on the client note
          • date_added - The timestamp in UTC that the note was added
          • date_updated - The timestamp in UTC that the note was last updated
        void4.1

        Companies.add

        A company is created

        EventsCompaniesCallback::add()

        • company_id - The ID of the company that was created.
        • vars - An array of input data which may include:
          • name - The name of the company
          • hostname - The hostname of the company
          • address - The address of the company
          • phone - The phone number of the company
          • fax - The fax number of the company
        void4.1

        Companies.edit

        A company is updated

        EventsCompaniesCallback::edit()

        • company
        GatewayManager.addA gateway is addedEventsGatewayManagerCallback::add()

         

        • gateway_id - The ID of the gateway company that was addedupdated.
        • vars - An array of input data which may include:
          • name - The name of the company
          • hostname company_id - The ID hostname of the company the gateway belongs to
          • class - The class name for this gateway
          • type - The type of gateway

         

        void4.1GatewayManager.editA gateway is updatedEventsGatewayManagerCallback::edit()
          • address - The address of the company
          • phone - The phone number of the company
          • fax - The fax number of the company
        • old_company(4.3.0) - An object representing the previous state of the companygateway_
            • id - The ID of the
            gateway that was updated.
          • vars - An array of input data which may include:
            • name - The name of the gateway
            • class - The class name for this gateway
            • type - The type of gateway
            • currencies - A numerically indexed array of accepted currencies codes (ISO 4217)
            • meta - A key/value array of meta data
            • company
            • name - The name of the company
            • hostname - The hostname of the company
            • address - The address of the company
            • phone - The phone number of the company
            • fax - The fax number of the company
        void4.1
        GatewayManager

        Companies.delete

        A gateway is removedEventsGatewayManagerCallback::delete()
        • gateway_id - The ID of the gateway that was removed.
        void4.1
        Invoices.addAn invoice is createdEventsInvoicesCallback::add()
        • invoice_id - The ID of the invoice created
        void3.1
        company is removed

        EventsCompaniesCallback::delete()

        • company_id - The ID of the company that was removed.
        • old_company(4.3.0) - An object representing the previous state of the company
          • id - The ID of the company
          • name - The name of the company
          • hostname - The hostname of the company
          • address - The address of the company
          • phone - The phone number of the company
          • fax - The fax number of the company
        void4.1

        Contacts.add

        A contact is added

        EventsContactsCallback::add()

        • contact_id - The ID of the contact that was created.
        • vars - An array of input data which may include:
          • client_id - The client ID this contact will be associated with
          • user_id - The user ID this contact belongs to if this contact has their own unique user record
          • contact_type - The type of contact
          • contact_type_id - The ID of the contact type if contact_type is 'other'
          • first_name - The first name of this contact
          • last_name - The last name of this contact
          • title - The business title for this contact
          • company - The company/organization this contact belongs to
          • email - This contact's email address
          • address1 - This contact's address
          • address2 - This contact's address line two
          • city - This contact's city
          • state - The 3-character ISO 3166-2 subdivision code, requires country
          • zip - The zip/postal code for this contact
          • country - The 2-character ISO 3166-1 country code, required if state is given
          • numbers An array of phone number data
        void4.1

        Contacts.edit

        A contact is updated

        EventsContactsCallback::edit()

        • contact_id - The ID of the contact that was updated.
        • vars - An array of input data which may include:
          • user_id - The user ID this contact belongs to if this contact has their own unique user record
          • contact_type - The type of contact
          • contact_type_id - The ID of the contact type if contact_type is 'other'
          • first_name - The first name of this contact
          • last_name - The last name of this contact
          • title - The business title for this contact
          • company - The company/organization this contact belongs to
          • email - This contact's email address
          • address1 - This contact's address
          • address2 - This contact's address line two
          • city - This contact's city
          • state - The 3-character ISO 3166-2 subdivision code, requires country
          • zip - The zip/postal code for this contact
          • country - The 2-character ISO 3166-1 country code, required if state is given
          • numbers An array of phone number data
        • old_contact(4.3.0) - An object representing the previous state of the contact
          • user_id - The user ID this contact belongs to if this contact has their own unique user record
          • contact_type - The type of contact
          • contact_type_name - The name or the language indentifier of the contact type
          • contact_type_is_lang - Whether the contact type name is a language identifier
          • contact_type_id - The ID of the contact type if contact_type is 'other'
          • first_name - The first name of this contact
          • last_name - The last name of this contact
          • title - The business title for this contact
          • company - The company/organization this contact belongs to
          • email - This contact's email address
          • address1 - This contact's address
          • address2 - This contact's address line two
          • city - This contact's city
          • state - The 3-character ISO 3166-2 subdivision code, requires country
          • zip - The zip/postal code for this contact
          • country - The 2-character ISO 3166-1 country code, required if state is given
          • date_added - The timestamp in UTC that the contact was added
        void4.1

        Contacts.delete

        A contact is removed

        EventsContactsCallback::delete()

        • contact_id - The ID of the contact that was removed.
        • old_contact(4.3.0) - An object representing the previous state of the contact
          • user_id - The user ID this contact belongs to if this contact has their own unique user record
          • contact_type - The type of contact
          • contact_type_name - The name or the language indentifier of the contact type
          • contact_type_is_lang - Whether the contact type name is a language identifier
          • contact_type_id - The ID of the contact type if contact_type is 'other'
          • first_name - The first name of this contact
          • last_name - The last name of this contact
          • title - The business title for this contact
          • company - The company/organization this contact belongs to
          • email - This contact's email address
          • address1 - This contact's address
          • address2 - This contact's address line two
          • city - This contact's city
          • state - The 3-character ISO 3166-2 subdivision code, requires country
          • zip - The zip/postal code for this contact
          • country - The 2-character ISO 3166-1 country code, required if state is given
          • date_added - The timestamp in UTC that the contact was added
        void4.1
        Emails.sendAn email template is sentEventsEmailsCallback::send()
        • action - The action that specifies the email group being sent
        • options - An array of options passed to Emails::send(), which may include:
          • to_client_id - The ID of the client the message was sent to
          • from_staff_id - The ID of the staff member the message was sent from
          • from - The from address override
          • from_name - The from name override
          • reply_to - The reply to address override
        • tags - A key/value pair of replacement tags for the email.

        array

        Key/value pairs to merge with tags.

        3.1
        Emails.sendCustomA non-template based email is sentEventsEmailsCallback::sendCustom()
        • options - An array of options passed to Emails::send(), which may include:
          • to_client_id - The ID of the client the message was sent to
          • from_staff_id - The ID of the staff member the message was sent from
          • reply_to - The reply to address override
        • tags - A key/value pair of replacement tags for the email.

        array

        Key/value pairs to merge with tags.

        3.1
        GatewayManager.addA gateway is addedEventsGatewayManagerCallback::add()
        • gateway_id - The ID of the gateway that was added.
        • vars - An array of input data which may include:
          • company_id - The ID of the company the gateway belongs to
          • class - The class name for this gateway
          • type - The type of gateway
        void4.1
        GatewayManager.editA gateway is updatedEventsGatewayManagerCallback::edit()
        • gateway_id - The ID of the gateway that was updated.
        • vars - An array of input data which may include:
          • name - The name of the gateway
          • class - The class name for this gateway
          • type - The type of gateway
          • currencies - A numerically indexed array of accepted currencies codes (ISO 4217)
          • meta - A key/value array of meta data
        • old_gateway(4.3.0) - An object representing the previous state of the gateway
          • id - The ID of the gateway
          • company_id - The ID of the company this gateway is installed for
          • name - The name of the gateway
          • class - The class name for this gateway
          • version - The version of the gateway
          • type - The type of gateway
          • meta - A list of meta data for the gateway
          • currencies - A list of objects representing currencies supported by this gateway
        void4.1
        GatewayManager.deleteA gateway is removedEventsGatewayManagerCallback::delete()
        • gateway_id - The ID of the gateway that was removed.
        • old_gateway(4.3.0) - An object representing the previous state of the gateway
          • id - The ID of the gateway
          • company_id - The ID of the company this gateway is installed for
          • name - The name of the gateway
          • class - The class name for this gateway
          • version - The version of the gateway
          • type - The type of gateway
          • meta - A list of meta data for the gateway
          • currencies - A list of objects representing currencies supported by this gateway
        void4.1
        Invoices.addAn invoice is createdEventsInvoicesCallback::add()
        • invoice_id - The ID of the invoice created
        void3.1
        Invoices.editAn invoice is updatedEventsInvoicesCallback::edit()
        • invoice_id - The ID of the invoice updated
        • old_invoice(4.3.0) - An object representing the invoice
          • id - The ID of the invoice
          • id_format - The format that the ID value should be displayed in
          • id_value - The ID for display
          • client_id - The client ID the invoice belongs to
          • date_billed - The date the invoice goes into effect
          • date_due - The date the invoice is due
          • date_closed - The date the invoice was closed
          • date_autodebit - The date the invoice should be autodebited
          • autodebit - Whether the invoice can be autodebited
          • status - The status of the invoice ('active','draft','proforma', or 'void')
          • subtotal - The subtotal of the invoice
          • total - The total of the invoice
          • paid - The amount the user has already paid on this invoice
          • previous_due - The amount that was due on this invoice before the last time it was edited
          • currency - The ISO 4217 3-character currency code of the invoice
          • note_public - Notes visible to the client
          • note_private - Notes visible only to staff members
        Invoices.editAn invoice is updatedEventsInvoicesCallback::edit()
        • invoice_id - The ID of the invoice updated
        void3.1
        Invoices.setClosedAn invoice is closedEventsInvoicesCallback::setClosed()
        • invoice_id - The ID of the invoice closed
        void3.1

        ModuleManager.add

        A module is installed

        EventsModuleManagerCallback::add() 

        • module_id - The ID of the module that was added.
        • vars - An array of input data which may include:
          • company_id - The ID of the company the module belongs to
          • class - The class name for this module

         

        void4.1
        ModuleManager.deleteA module is uninstalled

        EventsModuleManagerCallback::delete()

        • module_id - The ID of the module that was removed.
        void4.1
        Navigation.getSearchOptionsStaff search options are displayedEventsNavigationCallback::getSearchOptions()
        • options - A key/value pair of search options where each key is the URI to redirect search queries to and the value is the name of the search option. When implemented, the event handler should modify the options parameter using EventObject::setParams().
        • base_uri - The base URI for the currently logged in user.
        void3.0

        Packages.add

        A package is created

        EventsPackagesCallback::add()

         

        • package_id - The ID of the package that was created.
        • vars - An array of input data which may include:
          • module_id - The ID of the module this package belongs to
          • name - The name of the package
          • description - The description of the package
          • description_html - The HTML description of the package
          • qty - The maximum quantity available in this package, if any
          • module_row - The module row this package belongs to
          • module_group - The module group this package belongs to
          • taxable - Whether or not this package is taxable
          • single_term - Whether or not services derived from this package should be canceled at the end of term
          • status - The status of this package
          • company_id - The ID of the company this package belongs to
          • prorata_day - The prorated day of the month
          • prorata_cutoff - The day of the month pro rata should cut off
          • email_content - A numerically indexed array of email content
          • pricing - A numerically indexed array of pricing info
          • groups - A numerically indexed array of package group assignments
          • option_groups - A numerically indexed array of package option group assignments
          • (any other package field data passed to the module)
        void4.1

        Packages.edit

        A package is updated

        EventsPackagesCallback::edit()

        • package_id - The ID of the package that was updated.
        • vars - An array of input data which may include:
          • module_id - The ID of the module this package belongs to
          • name - The name of the package
          • description - The description of the package
          • description_html - The HTML description of the package
          • qty - The maximum quantity available in this package, if any
          • module_row - The module row this package belongs to
          • module_group - The module group this package belongs to
          • taxable - Whether or not this package is taxable
          • single_term - Whether or not services derived from this package should be canceled at the end of term
          • status - The status of this package
          • company_id - The ID of the company this package belongs to
          • prorata_day - The prorated day of the month
          • prorata_cutoff - The day of the month pro rata should cut off
          • email_content - A numerically indexed array of email content
          • pricing - A numerically indexed array of pricing info
          • groups - A numerically indexed array of package group assignments
          • option_groups - A numerically indexed array of package option group assignments
          • (any other package field data passed to the module)
        void4.1

        Packages.delete

        A package is removed

        EventsPackagesCallback::delete()

        • package_id - The ID of the package that was removed.
        void4.1
        Services.addA service is addedEventsServicesCallback::add()
        • service_id - The ID of the service added
        • vars - An array of input data which may include:
          • parent_service_id - The ID of the service this service is a child of
          • package_group_id - The ID of the package group this service was added from
          • pricing_id - The package pricing schedule ID for this service
          • client_id - The ID of the client this service belongs to
          • module_row - The module row to add the service under
          • coupon_id - The ID of the coupon used for this service
          • qty - The quanity consumed by this service
          • override_price - The price to set for this service, overriding the package pricing value for the selected term
          • override_currency - The currency to set for this service, overriding the package pricing value for the selected term
          • status - The status of this service
          • date_added - The date this service is added
          • date_renews - The date the service renews
          • date_last_renewed - The date the service last renewed
          • date_suspended - The date the service was last suspended
          • date_canceled - The date the service was last canceled
          • use_module - Whether or not to use the module for this request
          • prorate - Whether or not to prorate price changes
          • configoptions - An array of key/value pairs of package options where the key is the package option ID and the value is the option value
          • (any other service field data passed to the module)
        void3.4
        Services.editA service is editedEventsServicesCallback::edit()
        • service_id - The ID of the service edited
        • vars - An array of input data which may include:
          • parent_service_id - The ID of the service this service is a child of
          • package_group_id - The ID of the package group this service was added from
          • pricing_id - The package pricing schedule ID for this service
          • client_id - The ID of the client this service belongs to
          • module_row - The module row to add the service under
          • coupon_id - The ID of the coupon used for this service
          • qty - The quanity consumed by this service
          • override_price - The price to set for this service, overriding the package pricing value for the selected term
          • override_currency - The currency to set for this service, overriding the package pricing value for the selected term
          • status - The status of this service
          • date_added - The date this service is added
          • date_renews - The date the service renews
          • date_last_renewed - The date the service last renewed
          • date_suspended - The date the service was last suspended
          • date_canceled - The date the service was last canceled
          • use_module - Whether or not to use the module for this request
          • prorate - Whether or not to prorate price changes
          • configoptions - An array of key/value pairs of package options where the key is the package option ID and the value is the option value
          • (any other service field data passed to the module)
        void3.4
        Services.cancelA service is scheduled to be canceled, or is canceledEventsServicesCallback::cancel()
        • service_id - The ID of the service canceled
        • vars - An array of input data which may include:
          • date_canceled - The date this service is scheduled to be canceled
          • status - The status of the service (i.e. 'canceled')
          • use_module - Whether or not to use the module for this request
        void3.5
        Services.suspendA service is suspendedEventsServicesCallback::suspend()
        • service_id - The ID of the service suspended
        • vars - An array of input data which may include:
          • date_suspended The date the service was suspended
          • status - The status of the service (i.e. 'suspended')
          • use_module - Whether or not to use the module for this request
          • staff_id - The ID of the staff member that issued the service suspension
        void3.5
        Services.unsuspendA service is unsuspendedEventsServicesCallback::unsuspend()
        • service_id - The ID of the service unsuspended
        • vars - An array of input data which may include:
          • date_suspended The date the service was suspended (i.e. null)
          • status - The status of the service (i.e. 'active')
          • use_module - Whether or not to use the module for this request
          • staff_id - The ID of the staff member that issued the service unsuspension
        void3.5
        Staff.addA staff is created

        EventsStaffCallback::add()

        • staff_id - The ID of the staff that was created.
        • vars - An array of input data which may include:
          • user_id - The user ID belonging to this staff member
          • first_name - The first name of this staff member
          • last_name - The last name of this staff member
          • email - The email address of this staff member
          • email_mobile - The mobile email address of this staff member
          • status - The status of this staff member
          • groups - An array of staff group IDs this staff member belongs to
        void4.1
        Staff.editA staff is updated

        EventsStaffCallback::edit()

        • staff_id - The ID of the staff that was updated.
        • vars - An array of input data which may include:
          • user_id - The user ID belonging to this staff member
          • first_name - The first name of this staff member
          • last_name - The last name of this staff member
          • email - The email address of this staff member
          • email_mobile - The mobile email address of this staff member
          • status - The status of this staff member
          • groups - An array of staff group IDs this staff member belongs to
        void4.1
        Transactions.addA transaction is createdEventsTransactionsCallback::add()
        • transaction_id - The ID of the transaction created
        void3.1
        Transactions.editA transaction is updatedEventsTransactionsCallback::edit()
        • transaction_id - The ID of the transaction updated
        void3.1
        Users.loginA user logs inEventsUsersCallback::login()
        • user_id - The ID of the user that successfully logged in
        void3.1
        Users.logoutA user logs outEventsUsersCallback::logout()
        • user_id - The ID of the user attempting to log out
        void3.1

        ...

        To set the return value from the EventObject invoke the setReturnVal() method. Similarly, to fetch the return value use the getReturnVal() method.

        (4.3.0)