Event | Triggered When | Default Event Handler | Parameters | Returns | Since |
---|
Appcontroller.preAction | A URI is requested | EventsAppControllerCallback::preAction() | void | void | 3.0 |
Appcontroller.structure | A URI is requested without AJAX | EventsAppControllerCallback::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.add | A calendar event is created | EventsCalendarEventsCallback::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
| void | 4.1 |
CalendarEvents.edit | A calendar event is updated | EventsCalendarEventsCallback::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 | 4.1 |
CalendarEvents.delete | A calendar event is removed | EventsCalendarEventsCallback::delete() | - calendar_event_id - The ID of the calendar event that was removed.
| void | 4.1 |
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
| void | 4.1 |
ClientGroups.edit | A client group is updated | EventsClientGroupsCallback::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 this group
- company_id - The company ID this group belongs to
- color - The HTML color that represents this group
| void | 4.1 |
ClientGroups.delete | A client group is removed | EventsClientGroupsCallback::delete() | - client_group_id - The ID of the client group that was removed.
| void | 4.1 |
Clients.add | A client is added | EventsClientsCallback::add() | - client_id - The ID of the client that was added.
- 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
| void | 4.1 |
Clients.addNote | A note is created | EventsClientsCallback::addNote() | - note_id - The ID of the note that was 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
| void | 4.1 |
Clients.create | A client is created | EventsClientsCallback::create() | - client - An object representing the client that was created.
| void | 3.1 |
Clients.edit | A client is updated | EventsClientsCallback::edit() | - client_id - The ID of the client that was 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 client
| void | 4.1 |
Clients.editNote | A note is updated | EventsClientsCallback::editNote() | - note_id - The ID of the note that was updated.
- vars - An array of input data which may include:
- title - The title of the note
- description - The description of the note
| void | 4.1 |
Clients.delete | A client is removed | EventsClientsCallback::delete() | - client_id - The ID of the client that was removed.
| void | 4.1 |
Clients.deleteNote | A note is removed | EventsClientsCallback::deleteNote() | - note_id - The ID of the note that was removed.
| void | 4.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
| void | 4.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
| void | 4.1 |
Companies.delete | A company is removed | EventsCompaniesCallback::delete() | - company_id - The ID of the company that was removed.
| void | 4.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
| void | 4.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
| void | 4.1 |
Contacts.delete | A contact is removed | EventsContactsCallback::delete() | - contact_id - The ID of the contact that was removed.
| void | 4.1 |
Emails.send | An email template is sent | EventsEmailsCallback::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.sendCustom | A non-template based email is sent | EventsEmailsCallback::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.add | A gateway is added | EventsGatewayManagerCallback::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
| void | 4.1 |
GatewayManager.edit | A gateway is updated | EventsGatewayManagerCallback::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
| void | 4.1 |
GatewayManager.delete | A gateway is removed | EventsGatewayManagerCallback::delete() | - gateway_id - The ID of the gateway that was removed.
| void | 4.1 |
Invoices.add | An invoice is created | EventsInvoicesCallback::add() | - invoice_id - The ID of the invoice created
| void | 3.1 |
Invoices.edit | An invoice is updated | EventsInvoicesCallback::edit() | - invoice_id - The ID of the invoice updated
| void | 3.1 |
Invoices.setClosed | An invoice is closed | EventsInvoicesCallback::setClosed() | - invoice_id - The ID of the invoice closed
| void | 3.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
| void | 4.1 |
ModuleManager.delete | A module is uninstalled | EventsModuleManagerCallback::delete() | - module_id - The ID of the module that was removed.
| void | 4.1 |
Navigation.getSearchOptions | Staff search options are displayed | EventsNavigationCallback::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.
| void | 3.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)
| void | 4.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)
| void | 4.1 |
Packages.delete | A package is removed | EventsPackagesCallback::delete() | - package_id - The ID of the package that was removed.
| void | 4.1 |
Services.add | A service is added | EventsServicesCallback::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)
| void | 3.4 |
Services.edit | A service is edited | EventsServicesCallback::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)
| void | 3.4 |
Services.cancel | A service is scheduled to be canceled, or is canceled | EventsServicesCallback::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
| void | 3.5 |
Services.suspend | A service is suspended | EventsServicesCallback::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
| void | 3.5 |
Services.unsuspend | A service is unsuspended | EventsServicesCallback::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
| void | 3.5 |
Staff.add | A 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
| void | 4.1 |
Staff.edit | A 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
| void | 4.1 |
Transactions.add | A transaction is created | EventsTransactionsCallback::add() | - transaction_id - The ID of the transaction created
| void | 3.1 |
Transactions.edit | A transaction is updated | EventsTransactionsCallback::edit() | - transaction_id - The ID of the transaction updated
| void | 3.1 |
Users.login | A user logs in | EventsUsersCallback::login() | - user_id - The ID of the user that successfully logged in
| void | 3.1 |
Users.logout | A user logs out | EventsUsersCallback::logout() | - user_id - The ID of the user attempting to log out
| void | 3.1 |