This page lists all the events which can notify third party applications. If the event notification can contain a payload, a sample payload is described. If the event notification does not contain a payload, it is suggested that separate callback URLs be used for each event.

NOTE: Not all events may be available due to licensing restrictions.

CUSTOMER

CUSTOMER CREATED

This event is raised when a new customer is created.

Event Type: customer_created

Event Message:

{"event": "customer_created", "id": 1234, "name": "Customer Name"}

CUSTOMERS CREATED

This event is raised when multiple customers are created at once.

Event Type: customers_created

Event Message:

{"event": "customers_created", "id_list": [1,2,3,4]} # List of customer ids

CUSTOMERS CREATED NO PAYLOAD

Event Type: customers_created_no_payload

This event is raised when multiple customers are created and does not contain a payload.

CUSTOMER UPDATED

Event Type: customer_updated

This event is raised when a customer is updated.

Event Message:

{"event": "customer_updated", "id": 1234, "name": "Customer Name"}

The event is raised if any of the following customer attributes have been modified:

name, 
alt_customer_number,
balance_method,
charge_allowed,
check_allowed,
credit_ar_only,
credit_hold,
credit_limit,
credit_message,
credit_terms_id,
customer_privacy,
customer_type,
default_price_type_id,
use_declining_credit_limit,
declining_credit_limit,
has_jobs,
finance_charge_applied,
is_active,
is_po_required,
is_tax_exempt,
price_group_id,
pricing_sequence,
print_invoice,
salesperson_id,
statement_delivery_method,
statement_format,
store_account_opened_id,
tax_code_id,
tax_exempt_reason_id,
tax_exemption_expiration_date,
tax_exemption_number,
title,
first_name,
last_name,
email,
line_1,
line_2,
line_3,
city,
postal_code,
postal_code_location,
country,
is_primary_contact,
phone_number,
phone_type,
phone_country

CUSTOMERS UPDATED

Event Type customers_updated

This event is raised when multiple customers are updated at once.

Payload:

{"event": "customers_updated", "id_list": [list of customer ids]"}

Changes to any of the following attributes trigger this event:

name, 
alt_customer_number,
balance_method,
charge_allowed,
check_allowed,
credit_ar_only,
credit_hold,
credit_limit,
credit_message,
credit_terms_id,
customer_privacy,
customer_type,
default_price_type_id,
use_declining_credit_limit,
declining_credit_limit,
has_jobs,
finance_charge_applied,
is_active,
is_po_required,
is_tax_exempt,
price_group_id,
pricing_sequence,
print_invoice,
salesperson_id,
statement_delivery_method,
statement_format,
store_account_opened_id,
tax_code_id,
tax_exempt_reason_id,
tax_exemption_expiration_date,
tax_exemption_number,
title,
first_name,
last_name,
email,
line_1,
line_2,
line_3,
city,
postal_code,
postal_code_location,
country,
is_primary_contact,
phone_number,
phone_type,
phone_country

CUSTOMERS UPDATED NO PAYLOAD

Event Type: customers_updated_no_payload

This event is raised when multiple customers are updated at once and does not contain a payload.

The same attributes are considered as CUSTOMERS_UPDATED event.

USER

USER CREATED

Event Type: user_created

This event is raised when a new user is created.

Event Message:

{"event": "user_created", "id": "The user's ID", "username": "username"}

USERS CREATED

Event Type: users_created

This event is raised when multiple users are created at once.

Event Message:

{"event": "users_created", "id_list": "A list of user IDs"}

USERS CREATED NO PAYLOAD

Event Type: users_created_no_payload

This event is raised when multiple users are created at once and does not contain a payload.

USER IS ACTIVE CHANGED

Event Type: user_is_active_changed

This event is raised when a user's active flag is changed.

Event Message:

{  
	"event": "user_is_active_changed",
	"id": "The user's ID",
	"username": "username",
	"is_active": "The new value of is_active flag."
}

USER DELETED

Event Type: user_deleted

This event is raised when a user is deleted.

Event Message:

{"event": "user_deleted", "id": "The user's ID", "username": "username"}

USERS DELETED

Event Type: users_deleted

This event is raised when multiple users are deleted at once.

Event Message:

{"event": "users_deleted", "id_list": "[A list of user IDs]"

USERS DELETED NO PAYLOAD

Event Type: users_deleted_no_payload

This event is raised when multiple users are deleted at once and does not contain a payload.