ContactShipInstall

Summary

Send event data representing user or system actions to ContactShip, associating each input item with one event in batches of up to 100. Include event details such as event name, contact identification, and additional metadata to track the event occurrence within ContactShip.

Inputs

• eventName (required) — The name of the event that occurred, stored in lowercase snake_case (e.g., add_to_cart). Names starting with cs_ are reserved.
• contact (required) — A collection identifying the contact involved in the event. Provide at least one of contact ID, external ID, phone, or email, or supply a session ID. Fields include Contact ID, External ID, Phone, Email, Name, and Country for contact creation.
• additionalFields — Optional additional event details such as company info (ID and name), event ID to prevent duplicates, links related to the event, occurrence timestamp, JSON-encoded parameters, session ID, event value, currency, and whether to create the contact if not found.

Output shape

no body — success/failure only

Events are sent in batches of up to 100. Sending the same event ID multiple times does not create duplicates, making retries safe. Events require the Events add-on in ContactShip. If only a session ID is provided without contact identifiers, the event waits until the visitor is identified.

Examples

Example 1: Track a purchase event for a known contact

Specify eventName as 'purchase', identify the contact by contactId, include event value and currency, optionally set occurredAt to event time.

Links

• n8n community nodes installation guide