...
Programming endpoints
There are two three types of endpoints. Event endpoints, interface endpoints and app interface endpoints. In the chart below you can see every Microbizz hook, the type of endpoint and what parameters are passed to the endpoint.
| 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. | |
| 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 | ediline: The EDI line object that was converted todoitem: The product use object that was created todo: The todo the line is added to. |
| invoice | event_edi_line_approve | Event | Called every time an EDI line is approved. | |
| 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. |
| general | event_file_change | Event | Called whenever a file is changed | document: The document descriping the file |
| general | event_file_create | Event | Called whenever a file is created | document: The document descriping the file |
| general | event_note_change | Event | Called whenever a note is changed | message: The message object containing the note thread: The thread object containing the message |
| general | event_note_create | Event | Called whenever a note is created | message: The message object containing the note thread: The thread object containing the message |
| general | event_ftp_export | Event | Called when an frp is exported. | ftpPutter: The ftpExport data. filter: The filter used. |
| general | event_form_answer | Event | Called when a form is answered. | id: The id of the Questionaire object. approved: boolean if form is approved. handle: state of question answer. firstsave = 1, everysave = 2, saveforlater = 3, approve = 4 answers: Array of the answers. |
| 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. |
| person | event_person_change | Event | Called whenever a person is changed. | id: person id object: array of person data. |
| prodplan | menu | Interface | Adds a menu item in the planning module. | object: array of prodplan data |
| prodplan | event_prodplan_remove | Event | Called whenever a production planning is removed. | |
| registration | menu | Interface | Adds a menu item in the registration module. | |
| registration | event_registration_create | Event | Called when a registration is created. | id: registrationid registration: array containing the registrations data. |
| registration | event_registration_change | Event | Called when a registration is changed. | id: registrationid registration: array containing the registrations data. |
| 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_create | Event | Called every time a new product use is created. | object: The productuse object that was added as JSON. |
| 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 | event_todo_invoice | Event | Called every time a todo object is set to be invoiced. | id: invoice id |
| 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 | event_tool_attach_todo | Event | Call whenever a tool is attached to or detached from a task. | object: The tool object action: Either the string "attach" or the string "detach", more possible values may be added later todo: The todo object that was affected |
| 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. | |
| workplan | event_workplan_change | Event | Called every time a workplan has changed. | object: object as array of current workplan oldobject: object as array of old workplan other: exchange connections for relevant user. |
| appwidget | iframe | App Interface | Called every time the app displays a "column group" that includes this widget | The variables are passed in the GET parameters objecttype: The objecttype of the object where the widget is displayed id: The Microbizz ID of the object sessiontoken: A ssesion token that may be used for accessing the MIcrobizz API |
There is also a "settings" hook for each module:
...