How it works

This integration sends your audience engagement data—also available as reporting webhooks—to Amplitude, where you can use it alongside your other user and analytics data to gain insight into your audience’s behaviors.

Because Amplitude generally expects a unique, immutable user_id in events, we only send events to Amplitude when they represent a person with an id or a the event contains a device_id. We do not send events to Amplitude for people who do not have an id or aren’t represented by a device_id.

The events we send are both based on things that happen in and your customer activity. For example, an email sent event indicates that we’ve sent an email to a person, but an email clicked event lets you know that your audience clicked a link in your email.

sequenceDiagram actor a as Your Audience participant b as participant c as Amplitude b->>a: send email b-->>c: report email send a->>b: user clicks link b-->>c: report email clicked

Enable the Amplitude integration

As a part of this process, you’ll need your Amplitude API key.

  1. Go to Data & Integrations > Integrations and select the Amplitude integration card.

    find and enable the amplitude integration
    find and enable the amplitude integration

  2. Copy your Amplitude project’s API key into the API Key field. You’ll find your key in Amplitude Settings > Projects > General.

  3. (Optional) If your account is in Amplitude’s EU data centre, enable the Use EU Data Residency setting.

  4. Select the events that you want to send to Amplitude. We describe each event on the page. Check out our reporting documentation for more information about the data available to each event.

  5. (Optional) Enable Body Content to capture the first 1024 characters of messages in Sent events. This is an Amplitude limitation. You can still lookup deliveries in to see the full contents of sent messages.

  6. Click Save.

    select your events and click save
    select your events and click save

 Amplitude User IDs

Amplitude does not allow a UserID of 0. If you have a profile with an ID of 0, we’ll use the email address instead for only that profile.

Test your integration

When you add your API key and set up your integration, you can click Test Connection to make sure that your key is valid and connects to the correct project in Amplitude.

The test sends an email sent event to Amplitude to ensure that your API key is valid. You can check your Amplitude project for this email sent event to make sure that you set up your integration for the Amplitude project you want to send data to.

Payload reference

In this integration, we map our reporting webhook payloads to fit Amplitude. Below is a list of fields from our reporting webhooks and how we map them to Amplitude. We’ve also provided examples of both kinds of events.

Amplitude FieldDescription
platformrecipients.platformAs of March 28, 2024, we capitalize/camel-case these items, e.g. Web, Android, iOS.
event_typeobject_type + metricWe capitalize/camel-case these items, e.g. Email Sent
insert_idevent_idAmplitude uses this ID to de-duplicate events
timetimestampThe date-time when the event occurred
groupsaccount_id and workspace_idWhile your account and workspace IDs aren’t in our standard reporting webhook payload, we send this to Amplitude to support their Accounts add-on add on.
event_propertiesThis covers the remaining fields in the payload, including
  "$insert_id": "01GJDDNVWD723D5GNSEAQJVSEB",
  "$insert_key": "018a4e4d19084729ad7c4a77667a832afd#905",
  "$row_source": "realtime",
  "$schema": 13,
  "_time": 1669045350000,
  "adid": null,
  "amplitude_attribution_ids": null,
  "amplitude_event_type": null,
  "amplitude_id": 507275024343,
  "app": 419422,
  "city": null,
  "client_event_time": "2022-11-21 15:42:30",
  "client_upload_time": "2022-11-21 15:42:29.394000",
  "country": null,
  "data": {
    "group_first_event": {},
    "group_ids": {
      "257325": [
      "257326": [
  "data_type": "event",
  "device_brand": null,
  "device_carrier": null,
  "device_family": null,
  "device_id": "d148bf61-a152-5e08-bcc1-e8be96a9fce4",
  "device_manufacturer": null,
  "device_model": null,
  "device_type": null,
  "display_name": "Sms Sent",
  "dma": null,
  "event_id": 148912891,
  "event_properties": {
    "action_id": 1001266,
    "campaign_id": 1000223,
    "content": "Hey jenny! I got your number!",
    "customer_id": "313803",
    "delivery_id": "dgSiuAMBAMeAFMWAFAGEmtrrwMzFAHs6nMGmSG4=",
    "journey_id": "01GJDDNSY0X731SPYZEBKRNZZ1",
    "recipient": "5558675309"
  "event_time": "2022-11-21 15:42:30",
  "event_type": "Sms Sent",
  "global_user_properties": {},
  "group_properties": {
    "account_id": {
      "1": {}
    "workspace": {
      "56354": {}
  "groups": {
    "account_id": [
    "workspace": [
  "idfa": null,
  "ip_address": null,
  "is_attribution_event": false,
  "language": null,
  "library": "batch/1.0",
  "location_lat": null,
  "location_lng": null,
  "os": "",
  "os_name": null,
  "os_version": null,
  "partner_id": null,
  "paying": null,
  "plan": {},
  "platform": null,
  "processed_time": "2022-11-21 15:42:42.526145",
  "region": null,
  "sample_rate": null,
  "server_received_time": "2022-11-21 15:42:29.394000",
  "server_upload_time": "2022-11-21 15:42:39.646000",
  "session_id": -1,
  "source_id": null,
  "start_version": null,
  "timeline_hidden": false,
  "user_creation_time": "2022-11-21 15:42:28",
  "user_id": "313803",
  "user_properties": {},
  "uuid": "22ed3a6e-69b3-11ed-898f-d5a02747ae5a",
  "version_name": null
  "event_id": "01GJBCEYDJMH4VCDKXC98JNQ2D",
  "object_type": "sms",
  "timestamp": 166904535,
  "metric": "sent",
  "data": {
    "trigger_id": 1,
    "customer_id": "313803",
    "delivery_id": "dgSiuAMBAMeAFMWAFAGEmtrrwMzFAHs6nMGmSG4=",
    "action_id": 1001266,
    "campaign_id": 1000223,
    "journey_id": "01GJDDNSY0X731SPYZEBKRNZZ1",
    "identifiers": {
      "id": "313803",
      "email": "",
      "cio_id": "d9c106000001"
    "content": "Hey jenny! I got your number!",
    "recipient": "+15558675309"
Copied to clipboard!
Is this page helpful?