List of topics

You’ll notice that these events follow a pattern: resource.event

Here is the list of all available topics with a short description for each of them :

abonnement.created

Occurs whenever an abonnement has been created.

abonnement.updated

Occurs whenever an abonnement’s properties has been updated.

abonnement.deleted

Occurs whenever an abonnement has been deleted.

abonnement.activation_failed

Occurs whenever an abonnement activation has failed (for example because the cyclist doesn’t have a registered credit card).

abonnement.activation_succeeded

Occurs whenever an abonnement activation has succeded.

abonnement.validation_failed

Occurs whenever an abonnement validation has failed (for example because the cyclist doesn’t have a registered credit card).

abonnement.validation_succeeded

Occurs whenever an abonnement validation has succeded.

abonnement.validation_declined

Occurs whenever an abonnement activation has been declined by the operator.

abonnement.trial_will_end

Occurs 3 days before the abonnement trial period end.

boitier.locked

Occurs whenever a chain is added into a vehicule lock.

boitier.unlocked

Occurs whenever a chain is removed from a vehicule lock.

boitier.pass.unrecognized

Occurs whenever an NFC card NFC card is swiped on a vehicule and is not recognised by the system.

boitier.pin.incorrect

Occurs whenever an incorrect pin typed on a vehicule.

boitier.chain_type.updated

Occurs whenever the vehicule chain reading has changed.

cyclist.created

Occurs whenever a cyclist is created.

cyclist.confirmed

Occurs whenever a cyclist has confirmed is phone number.

cyclist.updated

Occurs whenever a cyclsit’s properties has been updated.

cyclist.deleted

Occurs whenever a cyclist is deleted.

dock.created

Occurs whenever a dock is created.

dock.updated

Occurs whenever a dock’s properties has been updated.

dock.deleted

Occurs whenever a dock is deleted.

pass.disassociated

Occurs whenever a pass is disassociated from a user.

pass.associated

Occurs whenever a pass is associated to a user.

pass.confirmed

Occurs whenever a pass is confirmed (if the pass is added from the vehicule, it should be confirmed with the cyclist phone number).

registration.updated

Occurs whenever a registration’s properties has been updated.

registration.deleted

Occurs whenever a registration is deleted.

station.created

Occurs whenever a station is created.

station.updated

Occurs whenever a station’s properties has been updated.

station.deleted

Occurs whenever a station is deleted.

station.favorite

Occurs whenever a station is added to a cyclist favorite list.

trip.created

Occurs whenever a trip is created.

trip.updated

Occurs whenever a trip’s properties has been updated.

trip.terminated

Occurs whenever a trip is completed

trip.marked

Occurs whenever a termination request is created for the trip.

trip.mark.updated

Occurs whenever a trip’s termination request is updated.

trip.resumed

Occurs whenever a trip in status terminating or termination_requested is set back to the renting status.

vehicule.battery.low

Occurs whenever a vehicule internal battery is under 20 percent.

vehicule.battery_vae.low

Occurs whenever a vehicule electrical assistance battery is under 20 percent.

vehicule.created

Occurs whenever a vehicule is created.

vehicule.updated

Occurs whenever a vehicule’s properties has been updated.

vehicule.position.forbidden

Occurs whenever a vehicule with a renting trip just went into a forbidden zone.

vehicule.deleted

Occurs whenever a vehicule is deleted.

zone.created

Occurs whenever a zone is created.

zone.updated

Occurs whenever a zone’s properties has been updated.

zone.deleted

Occurs whenever a zone is deleted.