Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ModcodeHookEndpoint typeEvent / positionVariables
calendarmenuInterfaceAdds a menu item in the calendar module.
customerevent_customer_changeEventCalled 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.

customermenuInterfaceAdds a menu item in the CRM module.


customertabInterfaceAdds a tab below every CRM object.

id: The Microbizz ID of the CRM object.

customernumber: The customer number

customerevent_person_attachEventIf a person is attached or detached from a company. trigger this

object: The customerpersonrelation that was changed as JSON. added origin event attached or detached.


invoiceevent_edi_changeEventCalled every time an EDI is changed in Microbizzobject: The EDI object that was changed, as JSON
invoiceevent_invoice_line_changeEventCalled every time an invoice line is changed in Microbizz.object: The invoice line object that was changed as JSON.
invoiceevent_edi_line_to_productuseEventCalled 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.

invoiceevent_edi_line_approveEventCalled every time an EDI line is approved.
invoicemenuInterfaceAdds a menu item in the invoice module.
invoicetabInterfaceAdds a tab below every invoice. (Only shown on posted invoices).

id: The Microbizz ID of the invoice.

invoicenumber: The invoice number.

generalevent_file_changeEventCalled whenever a file is changeddocument: The document descriping the file
generalevent_file_createEventCalled whenever a file is createddocument: The document descriping the file
generalevent_note_changeEventCalled whenever a note is changed

message: The message object containing the note

thread: The thread object containing the message

generalevent_note_createEventCalled whenever a note is created

message: The message object containing the note

thread: The thread object containing the message

generalevent_ftp_exportEventCalled when an frp is exported.

ftpPutter: The ftpExport data.

filter: The filter used.

generalevent_form_answerEventCalled when a form is answered.

id: The id of the Questionaire object.

approved: boolean if form is approved.

handle: state of question answer. 1 if first save.

answers: Array of the answers.

personmenuInterfaceAdds a menu item in the person module.
persontabInterfaceAdds a tab below every person.

id: The Microbizz ID of the person.

idnumber: The ID number of the person.

personevent_person_changeEventCalled whenever a person is changed.

id: person id

object: array of person data.

prodplanmenuInterfaceAdds a menu item in the planning module.object: array of prodplan data
prodplanevent_prodplan_removeEventCalled whenever a production planning is removed.
registrationmenuInterfaceAdds a menu item in the registration module.
registrationevent_registration_createEventCalled when a registration is created.

id: registrationid

registration: array containing the registrations data.

registrationevent_registration_changeEventCalled when a registration is changed.

id: registrationid

registration: array containing the registrations data.

registrationevent_registration_day_changeEventCalled when a worksheet is changed.

dayid: worksheetid

uref: userid

state: 1-3 (i.e. 'open', 'closed' and 'closed + accepted')

reportmenuInterfaceAdds a menu item in the report module.
salescontract_tabInterfaceAdds a tab below every sales contract.
salesmenuInterfaceAdds a menu item in the sales module.

id: The Microbizz ID of the sales contract.

number: The contract number.

startpageinfoboxInterfaceAdd the option to have an infobox.
startpagemenuInterfaceAdds a menu item in the start module.
supportmenuInterfaceAdds a menu item in the support module.
supporttabInterfaceAdds a tab below every support ticket.

id: The Microbizz ID of the support ticket.

number: The ticket number

todoevent_product_use_createEventCalled every time a new product use is created.object: The productuse object that was added as JSON.
todoevent_product_use_changeEventCalled every time a line of product use is changed in Microbizz.object: The productuse object that was changed as JSON.
todoevent_todo_changeEventCalled 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.

todoevent_todo_invoiceEventCalled every time the button Invoice now Send to invoice on a todo object and the todo is clickedinvoiced

id: invoice id

todomenuInterfaceAdds a menu item in the task module.
todotabInterfaceAdds a tab below every task.

id: The Microbizz ID of the task.

number: The task number.

toolevent_tool_changeEventCalled 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.

toolevent_tool_attach_todoEventCall 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

toolevent_tool_attach_customerEventCall whenever a tool is attached to or detached from a customer.

object: The tool object

action: Either the string "attach" or the string "detach", more possible values may be added later

customer: The customer object that was affected

toolmenuInterfaceAdds a menu item in the equipment module.
tooltabInterfaceAdds a tab below every piece of equipment.

id: The Microbizz ID of the equipment.

serialnumber: The serial number of the equipment.

usersmenuInterfaceAdds a menu item in the user module.
userstabInterfaceAdds a tab below every user object.

id: The internal Microbizz ID of the user displayed.

usercode: The user code of the user displayed.

usersevent_user_checkinEventCalled every time a user checks in on a task or some other objectobject: The checkin object
usersevent_user_checkoutEventCalled every time a user checks outobject: The checkin object
workplanmenuInterfaceAdds a menu item in the workplan module.
workplanevent_workplan_changeEventCalled 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.

appwidgetiframeApp InterfaceCalled 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

...