...
Modcode | Hook | Endpoint type | Event / position | Variables |
---|---|---|---|---|
calendar | menu | Interface | Adds a menu item in the calendar module. | |
customer | event_customer_change | Event | Called every time a CRM object is changed in Microbizz. | object: The customer object that was changed as JSON. previousobject: The customer object as it was before the changes. |
customer | menu | Interface | Adds a menu item in the CRM module. | ediline: The EDI line object that was converted todoitem: The product use object that was created |
customer | tab | Interface | Adds a tab below every CRM object. | id: The Microbizz ID of the CRM object. customernumber: The customer number |
invoice | event_edi_change | Event | Called every time an EDI is changed in Microbizz | object: The EDI object that was changed, as JSON |
invoice | event_invoice_line_change | Event | Called every time an invoice line is changed in Microbizz. | object: The invoice line object that was changed as JSON. |
invoice | event_edi_line_to_productuse | Event | Called every time an EDI line is converted to a product use | |
invoice | menu | Interface | Adds a menu item in the invoice module. | |
invoice | tab | Interface | Adds a tab below every invoice. (Only shown on posted invoices). | id: The Microbizz ID of the invoice. invoicenumber: The invoice number. |
person | menu | Interface | Adds a menu item in the person module. | |
person | tab | Interface | Adds a tab below every person. | id: The Microbizz ID of the person. idnumber: The ID number of the person. |
prodplan | menu | Interface | Adds a menu item in the planning module. | |
registration | menu | Interface | Adds a menu item in the registration module. | |
report | menu | Interface | Adds a menu item in the report module. | |
sales | contract_tab | Interface | Adds a tab below every sales contract. | |
sales | menu | Interface | Adds a menu item in the sales module. | id: The Microbizz ID of the sales contract. number: The contract number. |
startpage | infobox | Interface | Add the option to have an infobox. | |
startpage | menu | Interface | Adds a menu item in the start module. | |
support | menu | Interface | Adds a menu item in the support module. | |
support | tab | Interface | Adds a tab below every support ticket. | id: The Microbizz ID of the support ticket. number: The ticket number |
todo | event_product_use_change | Event | Called every time a line of product use is changed in Microbizz. | object: The productuse object that was changed as JSON. |
todo | event_todo_change | Event | Called every time a todo is changed in Microbizz. | object: The todo object that was changed as JSON. previousobject: The todo object as it was before the changes. |
todo | menu | Interface | Adds a menu item in the task module. | |
todo | tab | Interface | Adds a tab below every task. | id: The Microbizz ID of the task. number: The task number. |
tool | event_tool_change | Event | Called every time a tool is changed in Microbizz | object: The tool object that was changed as JSON. previousobject: The tool object as it was before the changes. |
tool | menu | Interface | Adds a menu item in the equipment module. | |
tool | tab | Interface | Adds a tab below every piece of equipment. | id: The Microbizz ID of the equipment. serialnumber: The serial number of the equipment. |
user | menu | Interface | Adds a menu item in the user module. | |
user | tab | Interface | Adds a tab below every user object. | id: The internal Microbizz ID of the user displayed. usercode: The user code of the user displayed. |
workplan | menu | Interface | Adds a menu item in the workplan module. |
There is also a "settings" hook for each module:
Modcode | Hook | Endpoint type | Event / position | Variables |
---|---|---|---|---|
Any module which provides a General settings menu item | settings | Settings | Adds an item to the General settings |
Interface endpoint
An interface endpoint is iframed into Microbizz, so the output of your script will be displayed inline in the Microbizz system. All variables are passed as GET variables. In addition to the variables mentioned in the chart above, you'll always receive a variable named sessiontoken which is the sessiontoken of the current Microbizz user. You can use the ValidateSessionToken API command to validate this session token, to ensure that your URL is actually called from the Microbizz system and not spoofed from somewhere else. You should use this call before outputting any information.
...