Events



The event stream

Any alteration to data on ChartHop represents an event.

You can retrieve events with the Event API, or set an app web hook to subscribe to an event pattern. Note that events are not exactly the same as changes (such as hires or departures), because an event can represent an amendment, or even a cancellation, of a change.

For example, if a new hire is entered, and then the date of that new hire is altered, this is just one new-hire change, but it's two events: change.create.hire and change.update.hire.

In general an event consists of an entity (the thing that is being acted upon), and a type the type of action that is happening to the entity. In some cases the event has a subtype which further describes the type of entity. All events have a code that consists of either entity.type or entity.type.subtype

Events

Event

Meaning

change.create.create

New job created

change.create.update

Job updated

change.create.hire

New hire

change.create.depart

Departure

change.create.move

Move/transfer

change.create.delete

Job removed

change.create.data

Data collected

change.update.create

Amendment to previous new job

change.update.update

Amendment to previous job update

change.update.hire

Amendment to hire

change.update.depart

Amendment to departure

change.update.move

Amendment to move

change.update.delete

Amendment to job removal

change.update.data

Amendment to collected data

change.delete.create

Cancellation of job creation

change.delete.update

Cancellation of job update

change.delete.hire

Cancellation of new hire

change.delete.depart

Cancellation of departure

change.delete.move

Cancellation of move

change.delete.delete

Cancellation of deletion

change.delete.data

Cancellation of collected data

person.create

New person created

person.update

Person updated

group.create

Group created

group.update

Group updated

group.delete

Group deleted

app.create

App created

app.update

App updated

user.create

User created

user.update

User updated

user.create.<appname>

App installed

user.update.<appname>

Installed app settings changed

user.token.<appname>

Token generated for installed app

user.delete.<appname>

App uninstalled

user.update_password

User password updated

user.remove_password

User password removed

user.invite

User invited into org

comment.create

Comment posted

comment.delete

Comment deleted

content.create

Content created

content.update

Content updated

content.delete

Content deleted

field.create

Custom field created

field.update

Custom field updated

field.delete

Custom field deleted

form.create

Custom form created

form.update

Custom form updated

form.delete

Custom form deleted

media.create

Media image uploaded

org.create

Org created

org.update

Org settings updated

process.create.<processname>

Process started

process.complete.<processname>

Process completed

process.error.<processname>

Process errored

report.create

Report created

report.update

Report updated

report.delete

Report deleted

report_chart.create

Report chart created

report_chart.update

Report chart updated

report_chart.delete

Report chart deleted

scenario.create

Scenario created

scenario.update

Scenario updated

scenario.delete

Scenario deleted