Skip to main content
The catalog is the list of events your systems send through the events API. It builds itself: each event shows up the first time it arrives, with nothing to create by hand. From here you choose how each one reads in the contact’s activity, and you send a test event to see the result before integrating.

​
What the list shows

Technical names always arrive in lowercase with underscores: if your system sends Add To Cart or addToCart, it is stored and shown as add_to_cart. See How events are named. The events ContactShip records, such as calls or campaigns received, are not in this list: they always look the same.

​
Choose how an event looks

Click an event to open How it looks. The preview uses the data of the last one that arrived, so you see the result before saving. Changes apply to the contact’s activity, the contact page and the inbox panel.

​
Send a test event

Click Send a test event. ContactShip records a Test event (test_event) through the same path the API uses, so you check that everything works without writing code.
  • It always goes to the same contact, Contacto de prueba de eventos (eventos.prueba@contactship.ai). It is created the first time and reused after that, so it never touches a real customer.
  • Open contact takes you to its page, where the event shows up in the activity.

​
Remove an event from the catalog

From How it looks, Remove from the catalog deletes that event’s settings: name, icon, title and the rest. Recorded events stay in the contacts’ activity, and if a new one arrives with that name, it comes back to the list with the default look. To get the test event back after removing it, send another one with Send a test event.

​
Who can do what

Without events.update, the editor opens read-only. See Roles and permissions.

​
FAQ

It shows up with the events add-on enabled and the events.read permission. The add-on is enabled on request: contact support.
No. The catalog lists what actually arrives, so it never shows events your system does not send. To see one before integrating, use the test event.
That is expected: names are normalized so the same event is not split into several. The name that is shown is yours to choose in Name.
No. It only stops showing in the contact’s activity. It still counts in the list, in filters and in reports.

​
See also

Contact events (API)

How to send the events of your systems.

Contact events

Where they show up and how to filter contacts by what they did.