ITiterable
events

Track an embedded message click

This endpoint tracks a click on an embedded message. It creates an <code>embeddedClick</code> event.<br/><br/>For test messages (proofs), no events are created.<br/><br/>Learn about <a href="https://support.iterable.com/hc/articles/29156459027348">identifying users by <code>userId</code> and <code>email</code></a>.

post/api/embedded-messaging/events/click

Request

  • Base URL
    https://api.iterable.com
  • Auth
    API key in header Api-Key

Request body

buttonIdentifierstring

ID of the button that was clicked (button IDs are defined in Iterable, as part of the template / campaign).

createdAtinteger

The time of the click's occurrence (Unix timestamp). If unspecified, gets set to the time Iterable received the event.

emailstring

An email address that identifies a user profile in Iterable. Provide an <code>email</code> or a <code>userId</code> (but not both), depending on <a href="https://support.iterable.com/hc/articles/29156459027348">how your project identifies users</a>.

messageIdstring required

ID of the message on which the click occurred.

targetUrlstring

URL associated with the click.

userIdstring

A user ID that identifies a user profile in Iterable. Provide an <code>email</code> or a <code>userId</code> (but not both), depending on <a href="https://support.iterable.com/hc/articles/29156459027348">how your project identifies users</a>.

Changes

No recorded changes to this operation across all 4 revisions of this API.